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

Báo cáo vấn đề Xem nguồn Hằng đêm · 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à nhà bảo trì nguồn thông tin đáng tin cậy về đóng góp của dự án của chúng tôi.
  2. Đặt kỳ vọng giữa những người đóng góp cho cộng đồng và dự án đơn vị bảo trì.

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 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ành viên DevEx thường sẽ đóng vấn đề và chuyển hướng người dùng đến StackOverflow và thảo luận sôi nổi về mức độ hiển thị cao hơn cho câu hỏi.
    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 vấn đề {: .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 chú ý ngay lập tức. Nếu có thì họ sẽ chỉ định P0 nhãn mức độ ưu tiên 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 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 đề 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ộng đồng mới có thể xử lý người đóng góp, 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 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 một Yêu cầu kéo

  1. Người dùng tạo một yêu cầu lấy dữ liệu.
  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 bản dựng được sử dụng nội bộ tại Google, chúng tôi cần kiểm tra tất cả các cam kết PR dựa trên bộ thử nghiệm 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 cam kết đã nhập vượt qua tất cả kiểm thử nội bộ, thì xác nhận cam kết đó sẽ bị thu gọn và xuất ngược lại sang 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 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. 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 kéo

  1. Lọc danh sách các yêu cầu lấy dữ liệu theo nhãn của nhóm.
  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. Hãy làm việc với người tạo yêu cầu lấy dữ liệu để hoàn tất quá 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 đơn vị bảo trì sử dụng để phân loại vấn đề.

  • P0 – Bị lỗi nghiêm trọng chức năng khiến bản phát hành Bazel (trừ các ứng viên phát hành) không sử dụng được hoặc dịch vụ bị ngừng hoạt động gây ảnh hưởng nghiêm trọng đến sự phát triển của Bazel dự án. 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. Trong 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 mức độ ưu tiên tiềm năng nếu có nhiều người dùng bị ảnh hưởng hơn.
  • hộp đá
    • Các vấn đề mà chúng tôi hiện không có thời gian để giải quyết cũng như đã đến lúc chấp nhậ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ể 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: Các vấn đề về 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 Console
  • team-Configurability: Các vấn đề mà nhóm Khả năng định cấu hình gặp phải. 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
    • Thông tin liên hệ: haxorz
  • 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-Loading-API: XÂY DỰNG tệp và xử lý macro: nhãn, gói(), chế độ hiển thị, hình cầu
  • 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 đề 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-API: API để viết quy tắc/khía cạnh: trình cung cấp, tệp chạy, hành động, cấu phần phần mềm
    • Thông tin liên hệ: comius
  • team-Rules-CPP / team-Rules-ObjC: Vấn đề đối với quy tắc C++/Target-C, bao gồm cả logic quy tắc gốc của Apple
  • team-Rules-Java: Vấn đề về các 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 đề đố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 đề đối với 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.