Trong tài liệu này, chúng tôi cung cấp danh sách các quy tắc được đề xuất.
Đây là một bộ quy tắc chất lượng cao, giúp mang lại trải nghiệm tốt cho người dùng. Chúng tôi phân định rạch ròi giữa các quy tắc được hỗ trợ và hàng trăm quy tắc mà bạn có thể tìm thấy trên Internet.
Đề cử
Nếu một bộ quy tắc đáp ứng các yêu cầu bên dưới, thì người duy trì quy tắc có thể đề cử bộ quy tắc đó vào các quy tắc được đề xuất bằng cách gửi báo cáo sự cố trên GitHub.
Sau khi được nhóm nòng cốt của Bazel xem xét, bộ quy tắc này sẽ được đề xuất trên trang web Bazel.
Yêu cầu đối với người duy trì quy tắc
- Bộ quy tắc phải cung cấp một tính năng quan trọng, hữu ích cho đông đảo người dùng Bazel (ví dụ: hỗ trợ một ngôn ngữ phổ biến).
- Bộ quy tắc được duy trì và cập nhật thường xuyên. Phải có ít nhất 2 người duy trì đang hoạt động.
- Bộ quy tắc có tài liệu chi tiết, kèm ví dụ và dễ sử dụng.
- Bộ quy tắc tuân theo các phương pháp hay nhất và có hiệu suất cao (xem hướng dẫn về hiệu suất).
- Bộ quy tắc đã được kiểm thử đủ mức cần thiết.
- Bộ quy tắc được kiểm thử trên BuildKite với phiên bản Bazel mới nhất. Các lượt kiểm thử phải luôn chạy thành công ở bước kiểm tra trước khi hợp nhất các thay đổi.
- Bộ quy tắc cũng được kiểm thử với những thay đổi không tương thích sắp tới. Các lỗi này phải được khắc phục trong vòng 2 tuần. Bạn cần báo cáo kịp thời các sự cố trong quá trình chuyển đổi cho đội ngũ Bazel.
Yêu cầu đối với nhà phát triển Bazel
- Các quy tắc được đề xuất phải thường xuyên được kiểm thử bằng phiên bản Bazel mới nhất (ít nhất một lần mỗi ngày).
- Các thay đổi trong Bazel không được gây ra lỗi cho một quy tắc được đề xuất (khi chạy với bộ cờ lệnh mặc định). Nếu điều này xảy ra, thay đổi đó phải được khắc phục hoặc thu hồi.
Loại bộ quy tắc khỏi danh sách đề xuất
Nếu bạn lo ngại rằng một bộ quy tắc cụ thể không còn đáp ứng các yêu cầu, hãy gửi báo cáo sự cố trên GitHub.
Chúng tôi sẽ liên hệ với người duy trì quy tắc và yêu cầu họ phản hồi trong vòng 2 tuần. Dựa trên kết quả, nhóm nòng cốt của Bazel có thể đưa ra quyết định loại bộ quy tắc khỏi danh sách đề xuất.