Tài liệu này dành cho những người đóng góp cho Bazel.
Nội dung mô tả cam kết trong Bazel bao gồm thẻ RELNOTES:, theo sau là ghi chú phát hành. Nhóm Bazel sử dụng tệp này để theo dõi các thay đổi trong mỗi bản phát hành và viết thông báo phát hành.
Tổng quan
Thay đổi của bạn có phải là bản sửa lỗi không? Trong trường hợp đó, bạn không cần ghi chú phát hành. Vui lòng thêm thông tin tham chiếu đến vấn đề trên GitHub.
Nếu thay đổi thêm / xoá / thay đổi Bazel theo cách mà người dùng có thể thấy, thì bạn nên đề cập đến thay đổi đó.
Nếu thay đổi đó là đáng kể, trước tiên, hãy tuân thủ chính sách về tài liệu thiết kế.
Nguyên tắc
Người dùng sẽ đọc ghi chú phát hành, vì vậy, ghi chú này phải ngắn gọn (lý tưởng nhất là một câu), tránh dùng thuật ngữ chuyên ngành (thuật ngữ nội bộ của Bazel), đồng thời tập trung vào nội dung thay đổi.
Thêm đường liên kết đến tài liệu có liên quan. Hầu hết mọi ghi chú phát hành đều phải có đường liên kết. Nếu nội dung mô tả đề cập đến một cờ, tính năng, tên lệnh, thì có thể người dùng sẽ muốn biết thêm về nội dung đó.
Sử dụng dấu nháy ngược xung quanh mã, biểu tượng, cờ hoặc bất kỳ từ nào có chứa dấu gạch dưới.
Đừng chỉ sao chép và dán nội dung mô tả lỗi. Chúng thường khó hiểu và chỉ có ý nghĩa đối với chúng tôi, khiến người dùng không hiểu chuyện gì đang xảy ra. Ghi chú phát hành nhằm giải thích những thay đổi và lý do thay đổi bằng ngôn ngữ dễ hiểu đối với người dùng.
Luôn sử dụng thì hiện tại đơn và định dạng "Bazel hiện hỗ trợ Y" hoặc "X hiện hỗ trợ Z". Chúng tôi không muốn ghi chú phát hành của mình nghe giống như các mục lỗi. Tất cả các mục trong ghi chú phát hành đều phải cung cấp thông tin và sử dụng ngôn ngữ cũng như phong cách nhất quán.
Nếu một tính năng nào đó đã bị ngừng cung cấp hoặc bị xoá, hãy dùng "X đã bị ngừng cung cấp" hoặc "X đã bị xoá". Không phải "đã bị xoá" hoặc "đã xoá".
Nếu Bazel hiện có hành vi khác, hãy dùng "X hiện có $newBehavior thay vì $oldBehavior" ở thì hiện tại. Điều này giúp người dùng biết chi tiết về những gì họ có thể mong đợi khi sử dụng bản phát hành mới.
Nếu Bazel hiện hỗ trợ hoặc không còn hỗ trợ một tính năng nào đó, hãy sử dụng "Bazel hiện hỗ trợ/không còn hỗ trợ X".
Giải thích lý do một nội dung bị xoá / không dùng nữa / thay đổi. Một câu là đủ nhưng chúng tôi muốn người dùng có thể đánh giá tác động đối với các bản dựng của họ.
KHÔNG hứa hẹn về chức năng trong tương lai. Tránh dùng các cụm từ như "cờ này sẽ bị xoá" hoặc "cờ này sẽ bị thay đổi". Điều này gây ra sự không chắc chắn. Điều đầu tiên mà người dùng sẽ thắc mắc là "khi nào?" và chúng tôi không muốn họ bắt đầu lo lắng về việc các bản dựng hiện tại của họ sẽ bị hỏng vào một thời điểm không xác định.
Quy trình
Trong quy trình phát hành, chúng tôi thu thập thẻ RELNOTES của mọi cam kết. Chúng tôi sao chép mọi thứ vào một Google Tài liệu để xem xét, chỉnh sửa và sắp xếp các ghi chú.
Trưởng nhóm phát hành sẽ gửi email đến danh sách gửi thư bazel-dev. Các cộng tác viên của Bazel được mời đóng góp vào tài liệu và đảm bảo rằng các thay đổi của họ được phản ánh chính xác trong thông báo.
Sau đó, thông báo sẽ được gửi đến blog Bazel bằng cách sử dụng kho lưu trữ bazel-blog.