Membuat Pesan Git Commit yang Baik untuk kolaborasi
Git adalah alat pengendali versi open source yang digunakan untuk mengelola perubahan dalam proyek perangkat lunak, dari skala kecil hingga besar. Penggunaan Git dihargai karena kemampuannya mempercepat dan meningkatkan efisiensi kontrol versi serta kolaborasi tim.
Setiap kali melakukan commit dengan Git, proyek disimpan dalam keadaan tertentu, memungkinkan pemulihan ke keadaan tersebut jika terjadi masalah selama proses pembaruan atau penambahan perubahan di atas keadaan sebelumnya.
Dalam setiap commit, pesan commit digunakan untuk memberikan deskripsi singkat tentang perubahan yang dilakukan. Pesan tersebut tidak hanya dibaca oleh pemilik commit, tetapi juga oleh anggota tim proyek. Oleh karena itu, membuat pesan commit yang jelas dan mudah dimengerti oleh anggota tim lainnya sangat penting.
Tips dan trik dapat membantu membuat pesan commit yang lebih informatif, membantu tim dalam memahami perubahan yang terjadi, dan mencegah kebingungan di masa mendatang.
Struktur pesan commit
Walaupun kamu bebas mengisi pesan commit tapi ini adalah struktur yang bisa kamu pakai bersama tim dalam mengisi pesan commit:
Tipe: Tipe commit, dalam contoh ini 'feat' untuk menunjukkan penambahan fitur.
Deskripsi singkat: Deskripsi singkat commit dengan maksimal 50 karakter.
Penjelasan: Penjelasan lebih lanjut tentang perubahan yang dilakukan, tidak lebih dari 80 karakter per baris.
Footer: Footer digunakan untuk menyertakan informasi tambahan seperti menutup issue yang terkait dengan commit.
Sekarang kita jelaskan struktur diatas
<tipe-commit>
Sekarang kita jelaskan struktur diatas
Tipe commit adalah jenis perubahan yang telah kamu lakukan. Tipe commit bisa kamu isi dengan:
feature: Jika kamu menambahkan fitur baru ke dalam proyek
fix: Jika kamu melakukan pembenahan terhadap bug yang diketahui
refactor: Jika kamu melakukan refactor terhadap berberapa bagian dari kode
test: Tuliskan jika kamu melakukan apapun terkait testing
docs: Tuliskan jika kamu melakukan apapun terkait dokumen — dokumen proyek
<subjek>
Tuliskan deskripsi singkat dari commit yang dilakukan dengan ketentuan penulisan sebagai berikut:
Berisi maksimal 50 karakter, pikirkan bahwa ini adalah judul dari pesan commit mu
Jelaskan secara singkat namun tepat sasaran
Jangan bertele — tele
<body>
Jelaskan perubahan apa yang kamu buat dan kenapa kamu membuatnya. Pastikan teks tidak lebih dari 80 karakter, anggota tim — mu biasanya malas membaca, jadi tuliskan sesingkat mungkin.
<footer>
Gunakan Footer untuk menjelaskan issue baru yang terjadi ketika perubahan selesai atau komentar, pemberitahuan dan peringatan pada developer dan tester lainya.
Contohnya, kamu bisa lihat dibawah:
fix: membenahi pengiriman email - form pendaftaran #20
Email saat ini memiliki limit yg menyebabkan pengiriman email gagal
Tolong tambahkan edit email pada pendaftaran
Dengan format pesan commit yang baik, tim pengembang dapat dengan mudah memahami perubahan yang dilakukan, tujuan dari perubahan tersebut, dan informasi tambahan yang relevan. Ini membantu dalam melacak sejarah perubahan proyek dan kolaborasi antar anggota tim.