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

Đây là hướng dẫn dành cho những nhà bảo 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 đáng tin cậy của các trình bảo trì cho quy trình đóng góp của dự án.
  2. Đặt kỳ vọng cho người đóng góp cho cộng đồng và người duy trì dự án.

Nhóm nòng cốt cộng tác viên của Bazel có các đội ngũ chuyên trách để quản lý các khía cạnh của dự án nguồn mở này. Đó 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ụ.
  • Nhà phát triển làm vườn trải nghiệm: Khuyến khích sự đóng góp của bên ngoài, xem xét các 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 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. Một người dùng tạo ra một vấn đề bằng cách sử dụng Mẫu vấn đề và vấn đề này nằm trong nhóm các vấn đề chưa được xem xét.
  2. Một thành viên trong nhóm phụ trách Trải nghiệm nhà phát triển (DevEx) sẽ đánh giá 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ành viên DevEx thường sẽ đóng vấn đề và chuyển hướng người dùng đến StackOverflow và bazel-discuss để tăng mức độ hiển thị của 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 sở hữu, chẳng hạn như rules_apple, thì thành viên DevEx sẽ chuyển vấn đề này sang đú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ẽ giao 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 đề, thành viên DevEx sẽ quyết định xem có cần xử lý ngay vấn đề đó hay không. Nếu có, họ sẽ chỉ định nhãn mức độ ưu tiên P0 và chủ sở hữu từ danh sách trưởng nhóm.
  4. Thành viên DevEx sẽ gán 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, 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 đề riêng của Mac. Ở giai đoạn này, vấn đề sẽ nằm trong nhóm các vấn đề chưa giải quyết được.

Mỗi nhóm phụ của Bazel sẽ phân loại mọi vấn đề theo nhãn mà họ sở hữu, tốt nhất là phân loại hằng tuần. Nhóm phụ sẽ xem xét và đánh giá vấn đề rồ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.

Sau khi giải quyết xong vấn đề, bạn có thể đóng vấn đề đó.

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

  1. Người dùng tạo một yêu cầu lấy dữ liệu.
  2. Nếu là thành viên của một nhóm Bazel và gửi PR trong khu vực của riêng bạn, bạn có trách nhiệm chỉ định nhãn nhóm của mình 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. Trưởng nhóm có thể tuỳ ý chỉ định một người khác đánh giá PR.
  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 PR được phê duyệt hoặc bỏ qua.
  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ộ của Google để kiểm thử 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 tôi cần kiểm thử tất cả các cam kết PR so với bộ kiểm thử nội bộ. Đây là lý do chúng tôi không hợp nhất trực tiếp các PR.
  6. Nếu lệnh xác nhận đã nhập vượt qua tất cả bài kiểm thử nội bộ, thì cam kết đó sẽ bị nén và xuất trở lại GitHub.
  7. Khi lệnh xác nhận hợp nhất vào thành phần 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 mọi vấn đề trong nhãn mà họ sở hữu, tốt nhất là theo tuần.

Vấn đề

  1. Lọc danh sách vấn đề theo nhãn nhóm của bạn 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 phụ DevEx ưu tiên nếu điểm đó là 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 vấn đề là P0 hoặc P1, thì chúng tôi giả định rằng vấn đề đó đang được giải quyết.
  4. Xoá nhãn untriaged.

Lưu ý rằng bạn cần phải ở trong 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 lấy dữ liệu theo nhãn nhóm.
  2. Xem xét các yêu cầu lấy dữ liệu đang mở.
    1. Không bắt buộc: Nếu bạn được chỉ định xem xét nội dung nhưng không phù hợp, hãy chỉ định lại người đánh giá thích hợp để 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 quy trình xem xét mã.
  4. Phê duyệt PR.
  5. Đảm bảo rằng tất cả các lượt 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ần gửi lại 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 PR.

Mức độ ưu tiên

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

  • P0 – Chức năng bị hỏng nghiêm trọng khiến bản phát hành Bazel (trừ các bản phát hành dùng thử) 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 quá trình phát triển dự án Bazel. Điều này bao gồm các lần hồi quy trong một bản phát hành mới chặn một 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 và không tuân thủ Chính sách về thay đổi có thể gây lỗi. Không có giải pháp thực tế nào tồn tại.
  • 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 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ó một giải pháp thiết thực. Thường thì bạn không cần làm gì ngay. Đang 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 chúng tôi hiện chưa xử lý. Vấn đề trực tiếp kiểm duyệt trong một phiên bản Bazel đã phát hành gây bất tiện cho người dùng cần phải giải quyết trong bản phát hành sau này và/hoặc có một giải pháp đơn giản.
  • P3 – Bản sửa lỗi nhỏ hoặc cải tiến mà bạn mong muốn trong khi tác động nhỏ. Không được ưu tiên đưa vào lộ trình của Bazel hay 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 đóng góp của cộng đồng.
  • P4 – Lỗi có mức độ ưu tiên thấp hoặc yêu cầu về tính năng ít có khả năng bị xử lý. Cũng có thể để mở để sắp xếp lại mức độ ưu tiên tiềm năng nếu có nhiều người dùng hơn bị ảnh hưởng.
  • 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ư không có thời gian nhận các khoản đóng góp. Chúng tôi sẽ đóng những vấn đề này để chỉ ra rằng không có ai xử lý các vấn đề này, nhưng sẽ tiếp tục theo dõi tính hợp lệ của các vấn đề này theo thời gian và khôi phục nếu có đủ người bị ảnh hưởng và nếu chúng tôi có tài nguyên để giải quyết chúng. Như thường lệ, bạn có thể nhận xét hoặc thêm biểu tượng cảm xúc cho những vấn đề này ngay cả khi đã đóng.

Nhãn nhóm

  • team-Android: Các vấn đề xảy ra với 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 đề về API BUILD, .bzl và Stardoc.
  • team-Configurability: Vấn đề liên quan đến nhóm Khả năng định cấu hình
  • team-Core: Các vấn đề đối với Nhóm cốt lõi
  • team-Documentation: Các vấn đề về nhóm Chứng từ
  • 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: Nhóm Vấn đề thực thi (Cục bộ)
  • team-OSS: Các vấn đề mà nhóm Bazel OSS: 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: Vấn đề của nhóm Hiệu suất Bazel
  • team-Remote-Exec: Các vấn đề của nhóm Thực thi (Từ xa)
  • team-Rules-CPP: Vấn đề về các 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
  • team-Rules-Python: Vấn đề về quy tắc Python gốc
  • team-Rules-Server: Vấn đề về quy tắc phía máy chủ có trong Bazel
  • team-Starlark-integration: Tích hợp không phải API Bazel + Starlark. Bao gồm: cách Bazel kích hoạt trình thông 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ữ XÂY DỰNG hoặc .bzl.
  • team-Starlark-interpreter: Các vấn đề về trình thông dịch Starlark (bất kỳ nội dung nào trong java.net.starlark). Các vấn đề về BUILD và .bzl API (thể hiện việc Bazel tích hợp với Starlark) sẽ xuất hiện 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 bằng nhãn nhóm.

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