Hướng dẫn cho nhà bảo trì sản phẩm Bazel

Báo cáo vấn đề Xem nguồn Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Đây là hướng dẫn dành cho những người duy trì dự án nguồn mở Bazel.

Nếu bạn muốn đóng góp cho Bazel, vui lòng đọc bài viết Đóng góp cho Bazel.

Mục tiêu của trang này là:

  1. Đóng vai trò là nguồn thông tin đáng tin cậy của người duy trì cho quy trình đóng góp của dự án.
  2. Đặt ra kỳ vọng giữa những người đóng góp trong cộng đồng và người duy trì dự án.

Nhóm cộng tác viên cốt lõi của Bazel có các nhóm nhỏ chuyên trách để quản lý các khía cạnh của dự án nguồn mở. Đó là:

  • Quy trình phát hành: Quản lý quy trình phát hành của Bazel.
  • Nhóm Xanh: Phát triển một hệ sinh thái lành mạnh gồm các quy tắc và công cụ.
  • Developer Experience Gardeners (Người chăm sóc trải nghiệm nhà phát triển): Khuyến khích các đóng góp bên ngoài, xem xét các vấn đề và yêu cầu kéo, đồng thời giúp quy trình phát triển của chúng tôi trở nên cởi mở hơn.

Bản phát hành

Tích hợp liên tục

Đọc hướng dẫn của nhóm Green về cơ sở hạ tầng CI của Bazel trên kho lưu trữ bazelbuild/continuous-integration.

Vòng đời của một vấn đề

  1. Người dùng tạo một vấn đề bằng cách sử dụng Mẫu vấn đề và vấn đề đó sẽ được thêm vào nhóm vấn đề mở chưa được xem xét.
  2. Một thành viên trong nhóm luân phiên của nhóm phụ trách Trải nghiệm cho nhà phát triển (DevEx) sẽ xem xét vấn đề này.
    1. Nếu vấn đề không phải là lỗi hoặc yêu cầu về tính năng, thì thành viên DevEx thường sẽ đóng vấn đề đó và chuyển hướng người dùng đến StackOverflow và bazel-discuss để câu hỏi được chú ý hơn.
    2. Nếu vấn đề thuộc một trong các kho quy tắc do cộng đồng sở hữu, chẳng hạn như rules_apple, thành viên DevEx sẽ chuyển vấn đề này sang kho lưu trữ chính xác.
    3. Nếu vấn đề không rõ ràng hoặc thiếu thông tin, thành viên DevEx sẽ chỉ định lại vấn đề cho người dùng để yêu cầu thêm thông tin trước khi tiếp tục. Điều này thường xảy ra khi người dùng không tuân theo Mẫu vấn đề.
  3. Sau khi xem xét vấn đề, nhân viên DevEx sẽ quyết định xem vấn đề đó có cần được chú ý ngay lập tức hay không. Nếu có, họ sẽ chỉ định nhãn P0 và một chủ sở hữu trong danh sách trưởng nhóm.
  4. Thành viên DevEx chỉ định nhãn untriaged và đúng một nhãn nhóm để định tuyến.
  5. Thành viên DevEx cũng chỉ định chính xác một nhãn type:, chẳng hạn như type: bug hoặc type: feature request, tuỳ theo loại vấn đề.
  6. Đối với các vấn đề cụ thể về nền tảng, thành viên DevEx sẽ chỉ định một nhãn platform:, chẳng hạn như platform:apple cho các vấn đề cụ thể về máy Mac. Ở giai đoạn này, vấn đề sẽ được đưa vào nhóm vấn đề mở chưa được phân loại.

Mỗi nhóm nhỏ của Bazel sẽ phân loại tất cả các vấn đề theo nhãn mà họ sở hữu, tốt nhất là hằng tuần. Nhóm nhỏ này sẽ xem xét và đánh giá vấn đề, đồng thời đưa ra giải pháp (nếu có thể). Nếu bạn là chủ sở hữu của một nhãn nhóm, hãy xem phần này để biết thêm thông tin.

Khi một vấn đề được giải quyết, bạn có thể đóng vấn đề đó.

Vòng đời của một yêu cầu kéo

  1. Người dùng tạo một yêu cầu kéo.
  2. Nếu là thành viên của nhóm Bazel và gửi một PR cho khu vực của riêng bạn, bạn chịu trách nhiệm chỉ định nhãn nhóm và tìm người đánh giá phù hợp nhất.
  3. Nếu không, trong quá trình phân loại hằng ngày, một thành viên DevEx sẽ chỉ định một nhãn nhóm và trưởng nhóm kỹ thuật (TL) của nhóm để định tuyến.
    1. TL có thể chỉ định người khác xem xét PR (không bắt buộc).
  4. Người đánh giá được chỉ định sẽ xem xét yêu cầu kéo và làm việc với tác giả cho đến khi yêu cầu đó được phê duyệt hoặc bị loại bỏ.
  5. Nếu được phê duyệt, người xem xét sẽ nhập(các) cam kết của PR vào hệ thống kiểm soát phiên bản nội bộ của Google để tiến hành các thử nghiệm khác. Vì Bazel là hệ thống bản dựng giống với hệ thống được dùng nội bộ tại Google, nên chúng ta cần kiểm thử tất cả các cam kết PR dựa trên bộ kiểm thử nội bộ. Đây là lý do khiến chúng tôi không hợp nhất các yêu cầu kéo trực tiếp.
  6. Nếu cam kết được nhập vượt qua tất cả các kiểm thử nội bộ, thì cam kết đó sẽ được nén và xuất trở lại GitHub.
  7. Khi cam kết hợp nhất vào nhánh chính, GitHub sẽ tự động đóng yêu cầu kéo.

Nhóm của tôi sở hữu một nhãn. Tôi nên làm gì?

Các nhóm nhỏ cần phân loại tất cả các vấn đề trong những nhãn mà họ sở hữu, tốt nhất là hằng tuần.

Vấn đề

  1. Lọc danh sách vấn đề theo nhãn nhóm và nhãn untriaged.
  2. Xem xét vấn đề.
  3. Xác định mức độ ưu tiên và chỉ định nhãn.
    1. Vấn đề này có thể đã được nhóm DevEx ưu tiên nếu đó là vấn đề P0. Sắp xếp lại thứ tự ưu tiên nếu cần.
    2. Mỗi vấn đề cần có đúng một nhãn mức độ ưu tiên. Nếu một vấn đề là P0 hoặc P1, chúng tôi giả định rằng vấn đề đó đang được xử lý.
  4. Xoá nhãn untriaged.

Xin lưu ý rằng bạn cần phải thuộc tổ chức bazelbuild để có thể thêm hoặc xoá nhãn.

Yêu cầu kéo

  1. Lọc danh sách yêu cầu kéo theo nhãn nhóm của bạn.
  2. Xem xét các yêu cầu kéo chưa được xử lý.
    1. Không bắt buộc: Nếu bạn được chỉ định xem xét nhưng không phù hợp với yêu cầu, hãy chỉ định lại người xem xét phù hợp để thực hiện quy trình xem xét mã.
  3. Làm việc với người tạo yêu cầu kéo để hoàn tất quy trình đánh giá mã.
  4. Phê duyệt yêu cầu kéo.
  5. Đảm bảo rằng tất cả các kiểm thử đều đạt.
  6. Nhập bản vá vào hệ thống kiểm soát phiên bản nội bộ và chạy các lệnh gửi trước nội bộ.
  7. Gửi bản vá nội bộ. Nếu bản vá được gửi và xuất thành công, thì GitHub sẽ tự động đóng PR.

Mức độ ưu tiên

Người duy trì sẽ sử dụng các định nghĩa sau đây về mức độ ưu tiên để phân loại vấn đề.

  • P0 – Chức năng chính bị lỗi khiến bản phát hành Bazel (trừ bản phát hành ứng cử viên) không dùng được hoặc dịch vụ ngừng hoạt động ảnh hưởng nghiêm trọng đến quá trình phát triển dự án Bazel. Điều này bao gồm cả những lỗi hồi quy xuất hiện trong một bản phát hành mới, khiến một số lượng đáng kể người dùng không thể sử dụng hoặc một thay đổi lớn không tương thích và không tuân thủ chính sách về Thay đổi lớn. Không có giải pháp thay thế nào hiệu quả.
  • P1 – Lỗi nghiêm trọng hoặc tính năng cần được giải quyết trong bản phát hành tiếp theo, hoặc một vấn đề nghiêm trọng ảnh hưởng đến nhiều người dùng (bao gồm cả việc phát triển dự án Bazel), nhưng có giải pháp thay thế thiết thực. Thường không yêu cầu hành động ngay lập tức. Có nhu cầu cao và được lên kế hoạch trong lộ trình của quý hiện tại.
  • P2 – Lỗi hoặc tính năng cần được giải quyết nhưng hiện tại chúng tôi chưa xử lý. Vấn đề vừa phải trong phiên bản Bazel đã phát hành gây bất tiện cho người dùng cần được giải quyết trong bản phát hành sau này và/hoặc có giải pháp dễ dàng.
  • P3 – Bản sửa lỗi nhỏ hoặc bản cải tiến mong muốn có tác động nhỏ. Không được ưu tiên trong lộ trình của Bazel hoặc bất kỳ bản phát hành sắp tới nào, tuy nhiên, chúng tôi khuyến khích cộng đồng đóng góp.
  • P4 – Lỗi có mức độ ưu tiên thấp hoặc yêu cầu về tính năng khó có thể được giải quyết. Cũng có thể vẫn mở để có thể sắp xếp lại mức độ ưu tiên nếu có nhiều người dùng bị ảnh hưởng hơn.
  • ice-box
    • Những vấn đề mà chúng tôi hiện không có thời gian giải quyết cũng như không có thời gian chấp nhận các khoản đóng góp. Chúng tôi sẽ đóng những vấn đề này để cho biết rằng không có ai đang xử lý chúng, nhưng sẽ tiếp tục theo dõi tính hợp lệ của chúng theo thời gian và khôi phục chúng nếu có đủ số người bị ảnh hưởng và nếu chúng tôi có đủ nguồn lực để giải quyết chúng. Như thường lệ, bạn có thể thoải mái bình luận hoặc thêm biểu tượng thể hiện cảm xúc vào những vấn đề này ngay cả khi chúng đã được đóng.

Nhãn nhóm

Đối với các vấn đề mới, chúng tôi đã ngừng sử dụng nhãn category: * để thay bằng nhãn nhóm.

Xem danh sách đầy đủ các nhãn tại đây.