Panduan membuat GIT commit message
 |
| Ilustrasi melakukan GIT commit. |
GIT commit message adalah pesan yang ditambahkan pada saat kita melakukan GIT commit. yang perlu disadari disini adalah bahwa commit message merupakan salah satu sarana komunikasi penting anda dengan anggota tim lainnya.
"A good software development process is all about communication."
Membuat commit message bisa jadi hal yang tampak sepele tapi kadang juga menjadi bagian yang cukup tricky. commit message harus memberikan gambaran tentang perubahan dalam commitan tersebut tanpa harus melihat baris-perbaris kodenya, tapi bukan juga berarti menuliskan segala hal tentang baris-perbaris kode, cukup gambaran secara umum tentang perubahan yang dilakukan dan mengapa perubahan itu perlu ditambahkan.
Jangan membuat commit message yang terlalu panjang dan bertele-tele. Sebuah pesan commitan yang panjang juga dapat menjadi sesuatu yang tidak baik. Pesan commit yang baik biasanya terdiri dari 2 atau 3 baris kalimat saja.
Contoh pesan commit:
ABC-001 - Membuat fitur login
Menambahkan fitur login untuk frontend user dengan menggunakan email/username dan password.
Menambahkan validasi form login disisi clientside (JS) dan server (PHP).
Tips lainnya adalah dengan menjawab 3 pertanyaan yang dibuat oleh pak Peter Hutterer, yaitu:
- Mengapa (perubahan) ini diperlukan?
- Bagaimana (perubahan) ini mengatasi masalah sebelumnya?
- Apa efek yang ditimbulkan dengan adanya perubahan ini?
Contoh pesan commit:
ABC-002 - Memperbaiki fitur login
Memperbaiki user login yang error saat disabled user mencoba login.
Bila disabled user mencoba login maka akan redirest kembali ke form login dengan pesan error.
Saat membuat pesan commit kita harus mau memposisikan diri sebagai orang lain yang kemudian waktu akan meneruskan perkerjaan kita atau para maintainer applikasi yang kita kembangkan yang juga perlu tau tentang patch/perubahan yang telah kita buat.
Sumber:
Comments
Post a Comment