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 · 6,5

Đây là hướng dẫn dành cho 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 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 độ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 gặp phải sự cố bằng cách chọn một trong mẫu vấn đề và sẽ được đưa vào nhóm công cụ mở chưa được xem xét .
  2. Một thành viên tham gia chương trình xoay vòng nhóm phụ Trải nghiệm nhà phát triển (DevEx) đã xem xét vấn đề.
    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 về một trong các kho lưu trữ quy tắc do cộng đồng, như rules_apple, thành viên DevEx sẽ chuyển vấn đề này vào đúng kho lưu trữ.
    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 chọn đúng mẫu lỗi {: .external} hoặc cung cấp thông tin không đầy đủ.
  3. Sau khi xem xét vấn đề, thành 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 ư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à đúng một nhóm nhãn để định tuyến.
  5. Thành phầ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, theo loại vấn đề.
  6. Đối với các vấn đề riêng của 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.
  7. Nếu vấn đề có mức độ ưu tiên thấp và có thể được một cộng tác viên mới trong cộng đồng xử lý, thì thành viên DevEx sẽ chỉ định nhãn good first issue. Ở giai đoạn này, vấn đề sẽ chuyển vào nhóm các vấn đề mở chưa được phân loại.

Mỗi nhóm phụ 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 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, bạn 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 bạn là thành viên của một nhóm Bazel và gửi quảng cáo vi phạm chính sách ở khu vực của bạn, bạn chịu trách nhiệm gắn nhãn nhóm và tìm ra nhóm tốt nhất người đánh giá.
  3. Nếu không, trong quá trình phân loại hằng ngày, thành viên DevEx sẽ chỉ định một mã nhãn nhóm và trưởng nhóm kỹ thuật (TL) của nhóm để định tuyến.
    1. Bản tóm tắt có thể chỉ định một người khác phụ trách đánh giá PR (không bắt buộc).
  4. Người đánh giá được chỉ định sẽ xem xét PR và làm việc với tác giả cho đến khi đã đượ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 lệnh xác nhận hợp nhất thành kênh chính, GitHub sẽ tự động đóng PR.

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 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. Kiểm tra vấn đề.
  3. Xác định mức độ ưu tiên và chỉ định nhãn.
    1. Có thể nhóm phụ DevEx đã ưu tiên giải quyết vấn đề này nếu đó là P0. Hãy ưu tiên lại 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 lấy dữ liệu chưa xử lý.
    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 quản lý phiên bản nội bộ và chạy lượt gửi trước.
  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 người 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 hoặc tính năng nghiêm trọ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 – Lỗi hoặc tính năng cần được giải quyết nhưng chúng tôi hiện không xử lý. Vấn đề đang diễn ra ở mức trung bình trong một phiên bản Bazel đã phát hành gây bất tiện cho người dùng và cần được giải quyết trong bản phát hành trong tương lai và/hoặc có 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 về tính năng khó có thể được đóng. Cũng có thể được giữ nguyên để ưu tiên lại nếu có nhiều người dùng hơn bị ảnh hưởng.
  • hộp đá
    • 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ý các vấn đề đó, nhưng sẽ tiếp tục theo dõi tính hợp lệ của các vấn đề đó theo thời gian và khôi phục các vấn đề đó nếu có đủ người bị ảnh hưởng và nếu chúng tôi có đủ tài nguyên để xử lý các vấn đề đó. Như thường lệ, bạn có thể bình luận hoặc thể hiện cảm xúc vào các vấn đề này ngay cả khi đã đóng cửa.

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-CLI: Giao diện người dùng của bảng điều khiển
  • team-Configurability: Vấn đề dành cho nhóm Khả năng định cấu hình. Bao gồm: Cấu hình bản dựng cốt lõi và hệ thống chuyển đổi. Không bao gồm: Các thay đổi đối với cờ mới hoặc hiện có
  • team-Core: Skyframe, truy vấn bazel, BEP, phân tích cú pháp các tuỳ chọn, bazelrc
  • team-Documentation: Vấn đề dành cho 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-Loading-API: Xử lý tệp BUILD và macro: nhãn, gói(), chế độ hiển thị, glob
  • team-Local-Exec: Các vấn đề liên quan đến nhóm Thực thi (Cục bộ)
  • team-OSS: Các vấn đề dành cho nhóm OSS Bazel: cài đặt, quy trình phát hành, đóng gói Bazel, trang web, cơ sở hạ tầng tài liệu
  • team-Performance: Các vấn đề dành cho nhóm Hiệu suất Bazel
  • team-Remote-Exec: Vấn đề của nhóm Thực thi (từ xa)
  • team-Rules-API: API để viết các quy tắc/khía cạnh: trình cung cấp, tệp chạy, thao tác, cấu phần phần mềm
  • team-Rules-CPP / team-Rules-ObjC: Các vấn đề về quy tắc C++/Objective-C, bao gồm cả logic quy tắc gốc của Apple
  • team-Rules-Java: Vấn đề về quy tắc Java
  • team-Rules-Python: Vấn đề đối với các quy tắc Python gốc
  • team-Rules-Server: Các vấn đề về quy tắc phía máy chủ đi kèm với Bazel
  • team-Starlark-Integration: Tích hợp Bazel + Starlark không phải API. 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: các 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ề API BUILD và .bzl (đại diện cho việc tích hợp của Bazel với Starlark) nằm trong team-Build-Language.

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

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