Coding & data · Dengan contoh
Catatan rilis untuk pengguna dari riwayat commit
Ubah daftar commit teknis menjadi catatan rilis yang dipahami pengguna, mengikuti contoh entri yang baik, dengan perubahan internal disaring keluar.
1 kali kirim5 isianDiperbarui
Untuk: Programmer, pengelola produk kecil, dan mahasiswa yang merilis aplikasi atau proyek open source.
Diadaptasi dari Fabric (Daniel Miessler) (MIT)
Prompt siap salin
Prompt
Ubah riwayat commit ini menjadi catatan rilis versi {{nomor versi}} untuk {{pembaca, misalnya pengguna aplikasi kasir yang bukan programmer}}. Ikuti pola contoh berikut. Commit: fix: handle null discount in calc_total() Entri buruk: Memperbaiki null pada calc_total. Entri baik: Total belanja tidak lagi kosong saat transaksi tanpa diskon. Commit: feat: add CSV export to sales report page Entri buruk: Menambahkan ekspor CSV. Entri baik: Laporan penjualan sekarang bisa diunduh sebagai CSV untuk dibuka di Excel. Riwayat commit (hasil git log --oneline {{tag lama}}..{{tag baru}}; nama dan email penulis sudah saya hapus): """ {{tempel riwayat commit}} """ Kelompokkan menjadi: Baru, Diperbaiki, Diubah, dan Perlu diperhatikan (perubahan yang mengharuskan pengguna melakukan sesuatu). Satu kalimat per entri, ditulis dari sudut pandang pengguna. Buang perubahan yang tidak terasa oleh pengguna (refaktor, tes, CI, dependensi), tetapi daftarkan di bagian akhir berjudul "Disaring" supaya bisa saya periksa. Jangan mengarang manfaat atau fitur yang tidak tersirat dari pesan commit; bila sebuah commit tidak jelas dampaknya, tulis sebagai pertanyaan.
Isian yang harus kamu ganti
Ganti bagian yang disorot, termasuk tanda {{ }}.
- nomor versi
- pembaca, misalnya pengguna aplikasi kasir yang bukan programmer
- tag lama
- tag baru
- tempel riwayat commit
Bedah prompt: kenapa ini bekerja
Tiap potongan di bawah dikutip persis dari prompt di atas.
Entri baik: Total belanja tidak lagi kosong saat transaksi tanpa diskon.
Contoh ini menunjukkan perubahan sudut pandang dari nama fungsi ke hal yang dialami pengguna, standar yang sulit dijelaskan tanpa contoh.
Perlu diperhatikan (perubahan yang mengharuskan pengguna melakukan sesuatu)
Perubahan yang menuntut tindakan pengguna paling sering terlewat di catatan rilis dan paling banyak menimbulkan keluhan.
daftarkan di bagian akhir
Commit yang dibuang tetap terlihat, sehingga kamu bisa menangkap perubahan penting yang keliru dianggap urusan internal.
bila sebuah commit tidak jelas dampaknya, tulis sebagai pertanyaan
Pesan commit yang samar tidak boleh ditafsirkan menjadi klaim fitur, karena pengguna akan mencari fitur yang ternyata tidak ada.
Kalau jawabannya belum pas
Kirim di percakapan yang sama. Perintah yang spesifik jauh lebih efektif daripada "perbaiki lagi".
Perlu versi singkat
Ringkas catatan rilis tadi menjadi pengumuman maksimal 280 karakter untuk {{saluran, misalnya grup WhatsApp pengguna}}, dengan satu perubahan terpenting di depan.
Kelas terkait
- Git dan GitHub DasarMenyimpan riwayat berkas, membatalkan kesalahan, bekerja di cabang, berbagi lewat remote, dan menandai versi.
- Dokumentasi Teknis: Panduan Pengguna dan ProsedurPembaca dan jenis dokumen, prasyarat, langkah bernomor, hasil langkah, placeholder, catatan dan peringatan, troubleshooting, serta konsistensi istilah. Kelas ini menguji penerapan aturan tertulis pedoman gaya, bukan kemampuan menulis dokumen bebas.
Prompt lain di Coding & data
- Jelaskan pesan error dan cari penyebabnyaIsian formulir · Isi formulir bahasa, perintah, pesan error lengkap, dan kode terkait, lalu dapat arti error, dugaan penyebab, dan cara membuktikannya.
- Query SQL dari pertanyaan bisnisPercakapan bertahap · Tempel skema tabel sekali, pastikan AI memahaminya, lalu ajukan pertanyaan satu per satu dan dapat query beserta penjelasannya.
- Regex dari contoh yang cocok dan tidakDengan contoh · Daftar teks yang harus cocok dan yang harus ditolak jadi soal latihan bagi AI, lalu regex-nya diuji terhadap setiap contoh.
- Pesan commit dan deskripsi pull requestDua fase · Fase 1 meringkas diff dan memeriksa apakah perlu dipecah; fase 2 menulis pesan commit dan deskripsi PR dari ringkasan yang kamu setujui.