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