Panduan Menulis Pesan Git Commit yang Lebih Baik
Pesan commit yang baik dapat membantu tim pengembang untuk memahami sejarah proyek, mempermudah debugging, dan meningkatkan kolaborasi. Artikel ini akan membahas bagaimana cara menulis pesan Git commit yang lebih baik.
Mengapa Pesan Commit Penting?
Pesan commit memberikan konteks tentang apa yang telah berubah dalam kode dan mengapa perubahan tersebut dilakukan. Pesan commit yang jelas dan deskriptif dapat:
1. Membantu anggota tim lain untuk memahami perubahan yang telah dilakukan tanpa harus membaca kode secara detail.
2. Saat masalah muncul, pesan commit yang baik dapat membantu untuk melacak perubahan yang mungkin menyebabkan bug.
3. Menyediakan catatan yang jelas tentang bagaimana dan mengapa kode berubah dari waktu ke waktu.
Struktur Pesan Commit yang Baik
1. Garis Pertama: Ringkasan Singkat
Garis pertama dari pesan commit harus berupa ringkasan singkat dari perubahan yang dilakukan. Ringkasan ini harus:
• Singkat dan Padat: Maksimal 50 karakter.
• Deskriptif: Memberikan gambaran umum tentang perubahan.
• Menggunakan Kata Kerja Imperatif: Misalnya, “Add”, “Fix”, “Refactor”.
Contoh:
Fix login bug on user dashboard
2. Garis Kosong
Setelah ringkasan singkat, tambahkan satu garis kosong untuk memisahkan ringkasan dari detail lebih lanjut. Ini membantu dalam keterbacaan.
3. Paragraf Kedua: Penjelasan Detail
Di bagian ini, berikan penjelasan yang lebih mendetail tentang perubahan yang dilakukan. Jelaskan alasan perubahan, bagaimana perubahan dilakukan, dan dampaknya. Jika perlu, tambahkan informasi tambahan seperti referensi ke issue tracker atau bug report.
Contoh:
Fix login bug on user dashboard
The login button on the user dashboard was not responding due to a JavaScript error. Updated the event listener to correctly handle form submissions.
Tipe Pesan Commit
Untuk meningkatkan konsistensi dan keterbacaan, gunakan tipe pesan commit yang sesuai dengan jenis perubahan yang dilakukan:
1. feat: Memperkenalkan fitur baru.
Contoh :
feat: add user authentication module
2. fix: Memperbaiki bug.
fix: resolve login issue on user dashboard
3. chore: Perubahan yang tidak terkait dengan perbaikan atau fitur dan tidak memodifikasi file src atau test (misalnya memperbarui dependensi).
chore: update project dependencies
4. refactor: Refaktor kode yang tidak memperbaiki bug atau menambah fitur.
refactor: simplify authentication logic
5. docs: Pembaruan dokumentasi seperti README atau file markdown lainnya.
docs: update installation instructions
6. style: Perubahan yang tidak mempengaruhi makna kode, biasanya terkait dengan pemformatan kode seperti spasi, titik koma yang hilang, dan sebagainya.
style: fix code formatting issues
7. test: Menambahkan atau memperbaiki tes.
test: add unit tests for login function
8. perf: Peningkatan performa.
perf: optimize query performance
9. ci: Terkait dengan integrasi berkelanjutan.
ci: update CI configuration
10. build: Perubahan yang mempengaruhi sistem build atau dependensi eksternal.
build: update build script
11. revert: Mengembalikan commit sebelumnya.
revert: revert commit abc123
Tips untuk Menulis Pesan Commit yang Lebih Baik
1. Hindari pesan commit yang terlalu umum seperti “update” atau “fix”. Berikan detail tentang apa yang di-update atau diperbaiki.
2. Jika bekerja dalam tim, sepakati gaya penulisan pesan commit yang konsisten.
3. Sebisa mungkin, setiap commit harus fokus pada satu perubahan atau satu unit kerja. Ini membuat pesan commit lebih spesifik dan jelas.
4. Luangkan waktu sejenak untuk membaca kembali pesan commit sebelum melakukan commit. Pastikan sudah deskriptif dan mudah dipahami.
Kesimpulan
Melalui artikel ini, kita telah melihat gambaran umum tentang cara menulis pesan Git commit yang lebih baik. Pesan commit yang baik dapat mempermudah kolaborasi, meningkatkan produktivitas tim, dan memberikan dokumentasi yang jelas tentang perkembangan proyek.
Jika Anda tertarik untuk mengetahui lebih banyak informasi seputar teknologi, Simak artikel lainnya di artikel NIS Group!