Bắt đầu với mẫu tập trung vào người dùng
Thay mọi trường trong ngoặc vuông bằng thông tin đã xác minh. Bỏ các phần không liên quan thay vì bịa tính năng. Nếu không cần thao tác nâng cấp, hãy nói rõ sau khi kiểm tra đường nâng cấp được hỗ trợ.
# [Phiên bản] — [Ngày phát hành]
## Điểm nổi bật
- [Cải tiến người dùng nhìn thấy và ai được hưởng lợi]
## Nâng cấp
- Từ: [phiên bản cũ được hỗ trợ]
- Thao tác: [di chuyển bắt buộc hoặc không cần thao tác]
- Xác minh: [cách xác nhận nâng cấp thành công]
## Thay đổi phá vỡ tương thích
- [Hành vi thay đổi, người dùng bị ảnh hưởng và liên kết di chuyển]
## Sửa lỗi
- [Vấn đề đã giải quyết và liên kết issue hoặc pull request]
## Vấn đề đã biết
- [Hạn chế còn lại và cách khắc phục tạm]
## Người đóng góp
[Ghi nhận người đóng góp và liên kết nhật ký thay đổi đầy đủ]Biến ghi chú tự sinh thành lời giải thích dễ đọc
GitHub có thể tạo ghi chú gồm pull request đã hợp nhất, người đóng góp và liên kết nhật ký thay đổi đầy đủ. Hãy coi đó là bản nháp. Kiểm tra phạm vi phát hành, bỏ mục không liên quan và nhóm thay đổi theo công việc người dùng thực hiện.
Ví dụ, “Sửa trường hợp biên của bộ phân tích” không hướng dẫn được nhiều. Nếu đúng, hãy giải thích rằng tệp CSV có cột cuối trống giờ nhập chính xác, và dẫn liên kết bản sửa để xem chi tiết kỹ thuật. Đừng tuyên bố mọi lỗi phân tích đã hết khi chỉ sửa một trường hợp.
Kiểm tra đường nâng cấp trước khi thông báo
Thử nâng cấp theo tài liệu từ một phiên bản cũ được hỗ trợ. Kiểm tra liên kết tải xuống và bảo đảm tài liệu khớp bản phát hành. Phân biệt bản xem trước với bản ổn định và giúp người đọc dễ tìm hạn chế còn lại.
Đăng thông tin phát hành trước khi dẫn liên kết từ bài viết cộng đồng. Dùng thông báo để nêu bật một cải tiến có ý nghĩa, còn ghi chú phát hành là tài liệu tham khảo chi tiết. Ghi lại câu hỏi tiếp theo và làm rõ hướng dẫn khi cần.
Câu hỏi thường gặp
Ghi chú phát hành có giống nhật ký thay đổi không?
Chúng có phần giao nhau. Nhật ký thay đổi ghi nhận thay đổi theo thời gian; ghi chú phát hành giải thích một bản phát hành cụ thể và tác động tới người dùng. Liên kết chúng để độc giả chuyển giữa tổng quan và chi tiết.
Có thể đăng nguyên ghi chú tự sinh không?
Hãy rà soát trước. Tiêu đề pull request được tạo ra có thể thiếu bước di chuyển, tác động với người dùng hoặc vấn đề đã biết.
Mọi thay đổi mã nhỏ có nên xuất hiện trong điểm nổi bật không?
Không. Dành điểm nổi bật cho thay đổi quan trọng với người dùng và giữ lịch sử kỹ thuật chi tiết trong nhật ký thay đổi được liên kết.