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