Menulis Git Commit Message yang Bener: Panduan Santai tapi Serius
Git commit message adalah sesuatu yang sering kita anggap remeh. Tapi, kalau dipikir-pikir, commit message ini ibarat diary kecil yang mencatat perjalanan kita dalam proyek. Bedanya, diary ini bisa dibaca oleh semua orang di tim (dan mungkin masa depan kita sendiri). Jadi, penting banget buat kita untuk nulis commit message yang jelas, informatif, dan nggak bikin kepala orang pusing pas baca.
Kenapa Commit Message itu Penting?
-
Buat Masa Depan Lebih Cerah
Bayangin kamu lagi debugging bug misterius di proyek yang udah dikerjakan 6 bulan lalu. Kamu buka history Git, dan satu-satunya petunjuk adalah commit message seperti ini:
Fix
Fix apa, Sob? Fix hubungan? Fix keuangan? Atau fix typo? Kita nggak tau.
Commit message yang baik adalah investasi kecil yang bikin kita (dan tim kita) nggak stres di masa depan. Ibaratnya, kayak kasih petunjuk arah biar nggak nyasar pas hiking.
-
Bantu Kolaborasi Tim
Ketika kita kerja dalam tim, commit message itu cara kita ngobrol lewat kode. Pesan yang jelas bikin semua orang paham apa yang kita lakukan tanpa harus tanya langsung. Jadi, hemat waktu dan energi!
-
Dokumentasi Gratis
Commit message itu sebenarnya dokumentasi proyek yang tertanam langsung di kode. Kalau kita rajin nulisnya, kita nggak perlu nulis ulang dokumentasi yang sama di tempat lain.
Contoh Commit Message dalam Berbagai Kasus
-
Penambahan Fitur
Skenario: Kita nambahin fitur baru untuk mengirim notifikasi email.
Commit message yang bagus:
feat: add email notification feature - Added function to send transactional emails using SendGrid - Created new module `emailService` - Updated README with email configuration steps
Kenapa bagus? Karena jelas apa yang ditambahkan dan ada detailnya.
-
Memperbaiki Bug
Skenario: Ada bug di mana tombol submit nggak berfungsi.
Commit message yang jelek:
fix button
Commit message yang bagus:
fix: resolve submit button not working on form - Fixed event listener for the submit button - Tested with various form inputs to ensure functionality
-
Refactor Kode
Skenario: Kita refactor kode untuk memperbaiki struktur tanpa mengubah fungsionalitas.
Commit message yang bagus:
refactor: restructure user authentication module - Separated token generation logic into `authUtils.js` - Cleaned up redundant functions - Added unit tests for edge cases
-
Update Dokumentasi
Skenario: README perlu diperbarui karena ada setup baru.
Commit message:
docs: update README with setup instructions for Docker - Added Docker installation steps - Updated environment variable configurations
-
Ngapus Kode yang Nggak Kepake
Skenario: Kita menghapus fungsi lama yang nggak dipakai lagi.
Commit message:
chore: remove unused `legacyPayment` function - Removed deprecated code for legacy payment integration - Confirmed no active references in the codebase
Best Practices dalam Menulis Commit Message
-
Gunakan Konvensi
Konvensi seperti Conventional Commits membantu kita menjaga konsistensi. Formatnya biasanya seperti ini:
<type>: <short summary>
Di mana
type
bisa berupa:- feat: untuk fitur baru
- fix: untuk perbaikan bug
- refactor: untuk perubahan struktur kode tanpa menambah fitur
- docs: untuk update dokumentasi
- chore: untuk tugas kecil yang nggak memengaruhi kode aplikasi
-
Tulis Ringkas tapi Padat
Baris pertama commit message sebaiknya nggak lebih dari 50 karakter. Kalau ada detail tambahan, tambahin di baris kedua ke bawah. Contohnya:
feat: add user login functionality - Integrated JWT for authentication - Added `POST /login` endpoint
-
Gunakan Bahasa yang Jelas
Pakai bahasa yang mudah dimengerti. Kalau timmu pakai bahasa Inggris, ya pakai bahasa Inggris. Jangan tiba-tiba nyelipin bahasa alien. Misalnya:
feat: enable portal intergalactic synchronization
Boleh keren, tapi jangan bikin bingung.
-
Jangan Pelit Detail
Tapi jangan juga berlebihan. Tuliskan apa yang relevan. Misalnya:
fix: resolve checkout page error on mobile devices - Fixed CSS issue causing button misalignment - Updated media query for responsiveness
-
Jangan Gunakan Commit Tunggal untuk Segalanya
Hindari commit "rakitan" yang isinya campur aduk kayak salad. Misalnya:
update: everything
Pecah jadi beberapa commit kecil biar gampang di-track.
Apa yang Terjadi Kalau Kita Ngasal?
-
Bingung Sendiri
Bayangin lagi debugging bug lama dan ketemu commit message kayak gini:
asdlfkj
Kita bakal habis waktu cuma buat nebak-nebak maksudnya.
-
Reputasi Dipertaruhkan
Kalau commit message kita amburadul, teman satu tim bakal malas nge-review atau mungkin mulai mempertanyakan keahlian kita (ouch).
-
Tim Jadi Lambat
Ngasal nulis commit message bikin orang lain susah paham konteks perubahan, sehingga proses review jadi lebih lama.
Kesimpulan: Jangan Anggap Remeh
Menulis commit message yang bagus itu gampang-gampang susah, tapi manfaatnya luar biasa besar. Kita bisa bantu diri sendiri (dan orang lain) untuk kerja lebih efisien, mengurangi kebingungan, dan menjaga dokumentasi proyek tetap rapi.
Tips Terakhir
- Kalau nggak yakin, tanya diri sendiri: "Kalau aku baca ini 6 bulan lagi, apakah aku ngerti maksudnya?"
- Luangkan waktu beberapa detik lebih lama untuk nulis commit yang jelas daripada memperbaiki kekacauan nanti.
Ingat, Git commit message itu seperti pesan dari masa lalu ke masa depan. Jadi, mari kita jadi versi masa lalu yang keren!
Ditunggu karya karya terbaik nya selalu mass
BalasHapus