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

Báo cáo vấn đề Xem nguồn Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

Nếu bạn đang 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 đá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 cho cộng đồng và những người duy trì dự án.

Nhóm cộng tác viên cốt lõi của Bazel đã dành riêng để 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ụ.
  • Người làm vườn trải nghiệm của nhà phát triển: Khuyến khích đóng góp bên ngoài, đánh giá vấn đề và lấy yêu cầu, đồng thời làm cho quy trình phát triển của chúng tôi 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 đội ngũ Green về cơ sở hạ tầng CI của Bazel trên bazelbuild/continuous-integration kho lưu trữ.

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 đưa vào nhóm các vấn đề mở chưa được xem xét.
  2. Một thành viên trong 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ó được mức độ hiển thị cao hơn.
    2. Nếu vấn đề thuộc một trong các kho lưu trữ quy tắc thuộc sở hữu của cộng đồng, chẳng hạn như rules_apple, thì 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 để họ yêu cầu họ cung cấp thêm thông tin trước đang 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 báo cáo lỗi.
  3. Sau khi xem xét vấn đề, thành viên DevEx sẽ quyết định xem vấn đề có cần chú ý ngay lập tức. Nếu có, họ sẽ chỉ định nhãn ưu tiê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à chính xác một nhãn nhóm để định tuyến.
  5. Thành viên DevEx cũng chỉ định đúng 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 đề dành riêng cho 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 đề dành riêng cho Mac. Ở giai đoạn này, vấn đề sẽ chuyển vào nhóm chưa được xử lý và chưa xử lý xong .

Mỗi nhóm phụ của Bazel sẽ phân loại tất cả vấn đề theo nhãn mà họ sở hữu, tốt nhất là trên hàng tuần. Nhóm phụ sẽ xem xét và đánh giá vấn đề, đồng thời đưa ra 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 vấn đề được giải quyết, chúng tôi có thể đóng vấn đề đó.

Vòng đời của yêu cầu lấy dữ liệu

  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 một nhóm Bazel và gửi một yêu cầu thay đổi đối với lĩnh vực của riêng bạn, bạn sẽ 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) để đị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 nội dung quảng bá và làm việc với tác giả cho đến khi nội dung quảng bá đó được phê duyệt hoặc bị loại bỏ.
  5. Nếu được phê duyệt, người đánh giá sẽ nhập(các) cam kết của PR vào hệ thống quản lý phiên bản nội bộ để thử nghiệm thêm. Vì Bazel là cùng một hệ thống xây dựng được sử dụng nội bộ tại Google, nên chúng ta cần kiểm thử tất cả các thay đổi trong PR dựa trên bộ kiểm thử nội bộ. Đây là lý do chúng tôi không hợp nhất các hoạt động PR một cách trực tiếp.
  6. Nếu thay đổi đã nhập vượt qua tất cả các kiểm thử nội bộ, thay đổi đó sẽ được hợp nhất và xuất trở lại GitHub.
  7. Khi thay đổi được hợp nhất vào nhánh chính, GitHub sẽ tự động đóng yêu cầu thay đổi.

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

Các nhóm phụ cần phân loại tất cả vấn đề trong nhãn 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. Kiểm tra vấn đề.
  3. Xác định mức độ ưu tiên và gán nhãn.
    1. Vấn đề này có thể đã được nhóm phụ DevEx ưu tiên nếu đó là vấn đề P0. Sắp xếp lại mức độ ưu tiên nếu cần.
    2. Mỗi vấn đề cần có đúng một nhãn ưu tiên. Nếu một là P0 hoặc P1 mà chúng tôi giả định đang được tích cực xử lý.
  4. Xoá nhãn untriaged.

Lưu ý rằng bạn phải ở trong bazelbuild tổ chức để có thể thêm hoặc xóa nhãn.

Yêu cầu lấy dữ liệu

  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 đang mở.
    1. Không bắt buộc: Nếu bạn được chỉ định xem xét nhưng mô hình đó không phù hợp đối với đơn vị quảng cáo đó, hãy chỉ định lại người đánh giá thích hợp để họ 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 xem xét mã.
  4. Phê duyệt PR.
  5. Đảm bảo rằng tất cả các bài kiểm thử đều thành công.
  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 bản gửi trước nội bộ.
  7. Gửi bản vá nội bộ. Nếu bản vá gửi và xuất thành công, GitHub sẽ tự động đóng chương trình quan hệ công chúng.

Mức độ ưu tiên

Các định nghĩa sau đây về mức độ ưu tiên sẽ được đơn vị bảo trì sử dụng để 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ừ các bản phát hành đề xuất) không dùng được hoặc dịch vụ bị hỏng ảnh hưởng nghiêm trọng đến quá trình phát triển dự án Bazel. Quy định này bao gồm cả các lượt hồi quy trong một bản phát hành mới chặn số lượng người dùng đáng kể hoặc một thay đổi có thể gây lỗi không tương thích nhưng không được tuân thủ chính sách Lỗi Thay đổi . Không có giải pháp thực tế nào.
  • 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 thực tế. 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 – Khiếm khuyết 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 thực hiện. Vấn đề về sự kiện phát trực tiếp ở mức độ trung bình trong một phiên bản Bazel được 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ó một giải pháp dễ dàng.
  • P3 – Lỗi nhỏ đáng mong muốn sửa lỗi hoặc nâng cao với tác động nhỏ. Không được ưu tiên trong lộ trình của Bazel hoặc mọi bản phát hành sắp ra mắt, 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 tính năng không có khả năng bị đóng. Cũng có thể được để mở trong có thể ưu tiên lại 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 xử lý 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 các 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 qua và phục hồi họ nếu có đủ số người bị ảnh hưởng và nếu chúng tôi tình cờ để xử lý. Như thường lệ, bạn có thể bình luận hoặc thêm biểu tượng cảm xúc vào các vấn đề này ngay cả khi chúng đã đóng.

Nhãn của nhóm

  • team-Android: Vấn đề dành cho nhóm Android
  • team-Bazel: Các vấn đề chung về sản phẩm/chiến lược của Bazel
  • team-Build-Language: Các vấn đề đối với API BUILD, .bzl và Stardoc.
  • team-Configurability: Vấn đề của nhóm Khả năng định cấu hình
  • team-Core: Các vấn đề đối với Nhóm chính
  • team-Documentation: Các vấn đề về nhóm Tài liệu
  • team-ExternalDeps: Xử lý phần phụ thuộc bên ngoài, Bzlmod, kho lưu trữ từ xa, tệp WORKSPACE
  • team-Local-Exec: Vấn đề dành cho nhóm Thực thi (Địa phương)
  • team-OSS: Các vấn đề mà nhóm Bazel OSS gặp phải: cài đặt, quy trình phát hành, đóng gói của Bazel, trang web, cơ sở hạ tầng tài liệu
  • team-Performance: Các vấn đề về nhóm Hiệu suất Bazel
  • team-Remote-Exec: Vấn đề liên quan đến nhóm Thực thi (Từ xa)
  • team-Rules-CPP: Các vấn đề về quy tắc C++, bao gồm cả logic quy tắc gốc của Apple
  • team-Rules-Java: Vấn đề về quy tắc Java
    • Thông tin liên hệ: comius
  • team-Rules-Python: Các vấn đề về quy tắc Python gốc
    • Thông tin liên hệ: comius
  • team-Rules-Server: Các vấn đề đối với quy tắc phía máy chủ đi kèm với Bazel
    • Thông tin liên hệ: comius
  • team-Starlark-integration: Tích hợp Bazel không phải API Bazel + Starlark. Bao gồm: cách Bazel kích hoạt trình phiên dịch Starlark, Stardoc, chèn nội dung tích hợp, mã hoá ký tự. Không bao gồm: Vấn đề về ngôn ngữ BUILD hoặc .bzl.
  • team-Starlark-interpreter: Các vấn đề về trình phiên dịch Starlark (mọi vấn đề trong java.net.starlark). Các vấn đề về BUILD và .bzl API (thể hiện việc tích hợp của Bazel với Starlark) sẽ xảy ra trong team-Build-Language.

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

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