Cara Menulis Pesan Git Commit yang Efektif dan Bermanfaat

Pesan komit adalah deskripsi singkat dari setiap komit dalam sistem kontrol versi seperti Git. Saat Anda melakukan perubahan pada file proyek Anda, Anda harus memberikan pesan yang menjelaskan apa yang mereka lakukan atau mengapa Anda membuatnya.

Pesan komit berfungsi sebagai bentuk dokumentasi dan komunikasi. Mereka memainkan peran penting dalam mempertahankan riwayat versi proyek yang jelas dan terorganisir. Pelajari cara menulis pesan komit yang baik dan anggota tim Anda yang lain akan lebih menghargai pekerjaan Anda.

Struktur Pesan Komitmen yang Baik

Contoh pesan komit yang baik mencakup empat bagian: Jenis, Deskripsi, Isi, dan Footer.

Seperti itu:

: 
[badan opsional]
[catatan kaki opsional]

Jenis

Jenis menjelaskan jenis perubahan yang dibuat dalam komit saat ini. Anda dapat menggunakan sistem apa pun yang masuk akal untuk keadaan Anda. Misalnya, berikut adalah beberapa contoh kata kunci yang dapat Anda gunakan untuk menandai setiap jenis perubahan, beserta contoh penggunaan:

• prestasi: perubahan Anda memperkenalkan fitur baru.
• memperbaiki: Anda memperbaiki bug.
• refaktor: kode refaktor perubahan Anda tanpa memperbaiki bug atau menambahkan fitur baru.
• tes: Anda membuat perubahan terkait pengujian. Misalnya, ketika Anda tes tulis dengan Jest atau apapun kerangka pengujian lainnya Anda memilih.
• pekerjaan rumah: perubahan yang tidak terkait dengan perbaikan, fitur, atau pengujian. Misalnya, memperbarui dependensi.
• dokumen: saat Anda memperbarui dokumentasi.
• gaya: perubahan yang tidak mempengaruhi arti kode, seperti menambahkan spasi, menghilangkan titik koma, dll.
• kinerja: perubahan terkait peningkatan kinerja.
• membangun: saat Anda membuat perubahan yang memengaruhi file build.
• ci: perubahan yang terkait dengan integrasi berkelanjutan.
• kembali: saat kembali ke komit sebelumnya.

Keterangan

"Deskripsi" pesan komit adalah ringkasan singkat dan deskriptif dari perubahan yang dibuat dalam komit. Ini berfungsi sebagai judul yang menangkap esensi dari komit.

Saat menulis deskripsi, ingatlah hal-hal berikut:

• Jelaskan dan cukup spesifik untuk mendeskripsikan komit secara sekilas.
• Buatlah singkat dan padat. Idealnya, membatasinya hingga 50 karakter atau kurang adalah yang terbaik.
• Tulislah dalam bentuk waktu sekarang, bahkan jika Anda menjelaskan perubahan yang telah dilakukan.
• Manfaatkan mood imperatif saat menulisnya.
• Mulailah dengan huruf kapital.
• Jangan akhiri dengan titik.

Misalnya:

feat: Terapkan sakelar mode gelap untuk beranda

Contoh ini menunjukkan bagaimana Anda dapat menulis deskripsi untuk melakukan itu mengimplementasikan mode gelap. Ini menggunakan prestasi type karena memperkenalkan fitur baru.

Tubuh (Opsional)

Bagian tubuh dari pesan komit memberikan detail dan konteks tambahan tentang perubahan yang dibuat dalam komit. Anda tidak akan selalu membutuhkan badan, tetapi dapat membantu memberikan lebih banyak informasi, menjelaskan alasan perubahan, atau menjelaskan pertimbangan teknis apa pun.

Berikut beberapa hal yang perlu diperhatikan saat menulis bagian isi pesan komit:

• Git tidak pernah membungkus teks secara otomatis, jadi bungkus secara manual dengan 72 karakter saat Anda menulis badan. Ini memberi Git ruang yang cukup untuk mengindentasi teks, membuatnya lebih mudah dibaca.
• Gunakan tubuh untuk menjelaskan apa yang terjadi dalam perubahan, mengapa Anda melakukan perubahan, dan alasan di balik perubahan Anda.
• Anda harus meninggalkan baris kosong antara baris deskripsi dan isi. Ini memungkinkan Git untuk membedakannya.
• Jika komit memperkenalkan banyak perubahan atau memengaruhi area basis kode yang berbeda, pertimbangkan untuk menggunakan poin-poin atau paragraf untuk memecah modifikasi. Ini meningkatkan keterbacaan dan membantu pembaca memahami berbagai aspek komit.

Misalnya:

feat: Tambahkan GitHub sebagai penyedia OAuth
Integrasikan GitHub sebagai penyedia OAuth agar mulus 
autentikasi dengan akun GitHub.
- Terapkan aliran autentikasi OAuth dengan GitHub API
- Konfigurasi titik akhir dan pengaturan yang diperlukan untuk autentikasi GitHub
- Perbarui antarmuka pengguna untuk menyertakan opsi login GitHub

Contoh di atas menunjukkan pesan komit Git yang bagus untuk fitur yang ditambahkan GitHub sebagai penyedia OAuth ke aplikasi Anda. Pesan komit ini memiliki baris ringkasan singkat (50 karakter atau kurang), teks penjelasan yang lebih rinci (dibungkus menjadi sekitar 72 karakter), dan poin-poin untuk informasi tambahan.

Bagian footer dalam pesan komit adalah bagian opsional yang menyediakan informasi tambahan atau metadata yang terkait dengan komit. Itu biasanya ditempatkan setelah bagian tubuh, dipisahkan oleh garis kosong. Footer dapat menyertakan berbagai jenis informasi, seperti referensi ke masalah terkait, tag, atau catatan khusus.

Saat mereferensikan masalah, permintaan tarik, atau item terkait lainnya, gunakan sintaks atau format yang sesuai yang diperlukan oleh sistem pelacakan masalah proyek Anda. Ini memastikan bahwa referensi dikenali dan ditautkan dengan benar.

Misalnya:

feat: Tambahkan GitHub sebagai penyedia OAuth
Integrasikan GitHub sebagai penyedia OAuth agar mulus 
autentikasi dengan akun GitHub.
- Terapkan aliran autentikasi OAuth dengan GitHub API
- Konfigurasi titik akhir dan pengaturan yang diperlukan untuk autentikasi GitHub
- Perbarui antarmuka pengguna untuk menyertakan opsi login GitHub
Menyelesaikan: #123
Lihat juga: #456, #789

Footer mereferensikan masalah terkait #123 dan menyebutkan masalah terkait lainnya #456 dan #789 untuk konteks tambahan.

Menambahkan Pesan Komit

Anda dapat menulis pesan komit menggunakan -M flag diikuti oleh pesan komit yang dilampirkan dalam tanda kutip (opsional tetapi disarankan).

Itu -M flag ideal untuk pesan komit singkat, biasanya menyertakan jenis dan deskripsi.

Misalnya:

git commit -m "tugas: Ubah linter ke ESlint"

Namun, jika pesan komit Anda membutuhkan lebih banyak detail, seperti badan dan catatan kaki, sebaiknya Anda menulis komit di editor teks atau IDE.

Atau, Anda dapat menulis pesan komit panjang dalam file teks dan menggunakan --mengajukan flag untuk menentukan pesan komit sebagai konten file teks.

Misalnya:

git commit --file commit_message.txt

Saat Anda menjalankan perintah di atas, git akan menggunakan konten file sebagai pesan komit.

Anda juga dapat memberi tahu git untuk membuka editor default Anda untuk menulis pesan yang lebih panjang. Jika Anda memiliki set variabel lingkungan GIT_EDITOR atau EDITOR, git akan membuka program itu saat Anda menjalankan program kosong git komit memerintah.

Mengapa Anda Harus Menulis Pesan Komitmen yang Baik

Menulis pesan komit yang baik sangat penting untuk kolaborasi yang efektif dan pemeliharaan kode. Pesan yang jelas dan deskriptif membantu pemahaman, debugging, dan tinjauan kode. Mereka bahkan dapat berkontribusi pada dokumentasi proyek atau catatan rilis.

Mereka mengaktifkan berbagi pengetahuan, kelancaran orientasi, dan mendukung kontrol versi. Memprioritaskan pesan komitmen kualitas meningkatkan proses pengembangan dan memastikan pemeliharaan basis kode.