Cara Menulis Commit Message Yang Baik Dalam Software Development

Kadang hal yang kecil dapat memberi dampak yang baik dimasa depan tanpa kita sadari, begitu juga dengan hal sepele sekecil menulis commit message yang bagus dan menjelaskan apa yang dikerjakan dan berdampak pada produktifitas kita dalam software development. Hal ini tidak hanya berdampak untuk diri kita sendiri tapi juga untuk team (jika kita bekerja secara team).

Mengapa Commit Message itu Penting? Bayangkan jika suatu saat ada anggota team atau bahkan anda sendiri ingin me-revert project setelah ada kesalahan, atau hanya ingin memastikan sudah pernah mengerjakan apa saja tapi sayangnya commit message tersebut tidak jelas sehingga sulit untuk mengembalikan project ke commit-an yang mana. Hal ini tentu saja mengganggu project atau proses development productivity baik bagi individu atau bahkan untuk team. So, dampaknya bisa tidak kecil kan karena urusan sepele seperti ini?

Bandingkan jika anda sudah menulis commit message dengan jelas dan tegas untuk menggambarkan apa yang kita kerjakan pada commitan tersebut. Tentu saja dikemudian hari jika terjadi masalah dan ingin mengembalikan ke commitan tertentu kita bisa menjadi lebih cepat dalam memilih nomer commitan dan tidak menjadi keraguan lagi.

contoh commit asal:

    commit fix 1

contoh commit benar:

    Fix: background color view input user profile

dari kedua contoh diatas terlihat jelas kan perbedaan yang mencolok? tentu saja, yang kedua lebih jelas.

Beberapa tips menulis commit-an:

    - Tulislah awalan huruf commitan dengan huruf kapital, sehingga menegaskan dimulainya pesan commitan tersebut
    - Berikan jenis type commit-an pada pesan commit, sebagai contoh apakah commitan ini sebagai Bugfix, Refactor, atau Hotfix
    - Usahakan commit message tidak terlalu panjang, usahakan singkat jelas dan padat
    - Gunakan bahasa imperative atau seperti kalimat perintah, meskipun kadang terdengar tidak sopan tapi efektif untuk commit message. Contohnya "Menambahkan fitur ABC" atau "Hapus fungsi yang sudah deprecated"
    - Gunakan kalimat langsung tanpa frasa yang menyatakan pendapat seperti "menurut saya", "saya pikir", dll

Isi dari commit message itu cukup penting, sehingga ketika menulis commit message perhatikan juga hal-hal berikut ini agar terjawab dengan commit message anda:

    - Apa alasan dari perubahaan dicommit-an ini
    - Apa effect dari perubahan ini
    - Kenapa perubahan ini diperlukan
    - Perubahan ini mengacu pada hal apa?

Terakhir pastikan tulis commit message dengan ringkas dengan sedemikian rupa sehingga pembaca commit message anda memiliki pemahaman tentang perubahan pada code anda. Jelaskan secara singkat tapi padat. Oke segitu dulu untuk artikel ini, terima kasih sudah membaca. Jika ada pertanyaan boleh diskusi dengan saya. Thanks!! Salam.

Written on November 26, 2021