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