Mulai dengan templat yang berfokus pada pengguna
Ganti setiap kolom dalam kurung dengan informasi yang telah diverifikasi. Hapus bagian yang tidak relevan alih-alih mengarang fitur. Jika pembaruan tidak membutuhkan tindakan, nyatakan secara jelas setelah memeriksa jalur pembaruan yang didukung.
# [Versi] — [Tanggal rilis]
## Sorotan
- [Peningkatan yang terlihat oleh pengguna dan siapa yang diuntungkan]
## Pembaruan
- Dari: [versi sebelumnya yang didukung]
- Tindakan: [migrasi yang diperlukan atau tidak perlu tindakan]
- Verifikasi: [cara memastikan pembaruan berhasil]
## Perubahan yang merusak kompatibilitas
- [Perilaku yang berubah, pengguna terdampak, dan tautan migrasi]
## Perbaikan
- [Masalah yang diselesaikan dan tautan issue atau pull request]
## Masalah yang diketahui
- [Keterbatasan yang tersisa dan solusi sementara]
## Kontributor
[Beri penghargaan kepada kontributor dan tautkan catatan perubahan lengkap]Ubah catatan yang dihasilkan menjadi penjelasan yang mudah dibaca
GitHub dapat menghasilkan catatan berisi pull request yang digabungkan, kontributor, dan tautan catatan perubahan lengkap. Perlakukan hasil itu sebagai draf. Periksa batas cakupan rilis, hapus entri yang tidak relevan, dan kelompokkan perubahan berdasarkan tugas pengguna.
Misalnya, “Perbaiki kasus tepi parser” hanya memberi sedikit petunjuk. Jika benar, jelaskan bahwa berkas CSV dengan kolom terakhir kosong sekarang dapat diimpor dengan benar, dan tautkan perbaikannya untuk detail teknis. Jangan mengklaim semua masalah parsing selesai ketika hanya satu kasus yang berubah.
Tinjau jalur pembaruan sebelum mengumumkan
Coba pembaruan yang didokumentasikan dari versi sebelumnya yang didukung. Periksa tautan unduhan dan pastikan dokumentasi sesuai dengan rilis. Bedakan versi pratinjau dari rilis stabil dan buat keterbatasan yang tersisa mudah ditemukan.
Terbitkan informasi rilis sebelum menautkannya dalam kiriman komunitas. Gunakan pengumuman untuk menyoroti satu peningkatan yang berarti, sedangkan catatan rilis tetap menjadi referensi terperinci. Catat pertanyaan lanjutan dan perjelas petunjuk jika diperlukan.
Pertanyaan umum
Apakah catatan rilis sama dengan catatan perubahan?
Keduanya saling tumpang tindih. Catatan perubahan merekam perubahan sepanjang waktu; catatan rilis menjelaskan rilis tertentu dan dampaknya terhadap pengguna. Tautkan keduanya agar pembaca dapat berpindah antara ringkasan dan detail.
Bisakah saya menerbitkan catatan yang dihasilkan otomatis tanpa perubahan?
Tinjau terlebih dahulu. Judul pull request yang dihasilkan mungkin tidak mencakup langkah migrasi, dampak terhadap pengguna, atau masalah yang diketahui.
Haruskah setiap perubahan kecil pada kode muncul dalam sorotan?
Tidak. Gunakan sorotan untuk perubahan yang penting bagi pengguna dan simpan riwayat teknis terperinci dalam catatan perubahan yang ditautkan.