Praktik Terbaik untuk Pesan Commit

Bayangkan Anda melihat kembali riwayat proyek Anda. Tanpa pesan commit yang jelas, rasanya seperti membaca buku harian dengan entri yang kosong!

Pesan commit yang baik sangat penting untuk memahami mengapa perubahan dibuat, apa yang diubah, dan bagaimana dampaknya terhadap proyek. Hal ini membantu Anda dan tim melakukan debug, meninjau kode, dan memperkenalkan anggota baru ke proyek.

Pesan commit Git standar memiliki dua bagian utama:

• Baris Subjek: Satu baris singkat yang merangkum perubahan.
• Isi (Opsional): Penjelasan yang lebih terperinci, dipisahkan dari subjek oleh satu baris kosong.

Bayangkan seperti email: baris subjek untuk pemindaian cepat dan isi untuk detail.

Baris subjek adalah bagian yang paling penting. Berikut aturannya:

• Singkat: Batasi hingga 50–72 karakter.
• Kalimat Perintah: Mulai dengan kata kerja dalam bentuk kini (misalnya, "Add feature", bukan "Added feature" atau "Adding feature").
• Gunakan Huruf Kapital pada Huruf Pertama: Ini merupakan praktik standar agar mudah dibaca.
• Tanpa Titik: Jangan akhiri baris subjek dengan titik.

Mari lihat beberapa baris subjek yang baik dan buruk:

• Baik: Fix: broken login button
• Baik: Feat: implement user profile page
• Buruk: Fixed a bug in the login system that was causing issues. (Terlalu panjang, menggunakan bentuk lampau)
• Buruk: updates (Terlalu umum)

Usahakan agar tetap jelas dan singkat!

Isi commit adalah tempat Anda menjelaskan alasan perubahan, konteks, dan detail apa pun yang tidak terlihat jelas dari kode itu sendiri.

Gunakan bagian ini saat perubahan Anda memerlukan penjelasan yang lebih panjang daripada yang dapat diberikan oleh baris subjek. Bungkus baris di sekitar 72 karakter agar lebih mudah dibaca dalam alat Git.

Saat menulis isi commit:

• Jelaskan mengapa perubahan dibuat, bukan hanya apa yang diubah.
• Jelaskan kompromi atau keputusan desain yang diambil.
• Sebutkan efek samping yang mungkin terjadi atau area yang perlu diperhatikan.
• Berikan satu baris kosong antara subjek dan isi.

Hal ini memberikan konteks berharga bagi pembaca di masa mendatang.

Berikut contoh pesan commit lengkap dengan struktur yang baik:

Banyak tim menerapkan konvensi yang mengharuskan baris subjek diawali awalan jenis. Hal ini membantu mengategorikan perubahan dengan cepat.

Awalan yang umum meliputi:

• feat: (fitur baru)
• fix: (perbaikan bug)
• docs: (perubahan dokumentasi)
• style: (gaya kode, tanpa perubahan fungsional)
• refactor: (refaktor kode)
• test: (menambahkan pengujian)
• chore: (pemeliharaan, perubahan proses build)

Merupakan praktik yang baik untuk menautkan commit Anda ke issue atau pull request terkait dalam sistem manajemen proyek (misalnya, GitHub Issues atau Jira).

Anda dapat melakukannya dengan menyertakan frasa seperti Closes #123, Fixes #45, atau Refs #67 dalam pesan commit, biasanya di bagian isi. Dengan demikian, perubahan kode Anda akan otomatis terhubung ke tugas yang sedang dilacak.

Manakah dari pilihan berikut yang merupakan karakteristik pesan commit Git yang ditulis dengan baik menurut praktik terbaik?

Anda telah mempelajari bahwa pesan commit yang disusun dengan baik sangat penting untuk kejelasan dan kolaborasi dalam proyek. Dengan mengikuti praktik terbaik ini, Anda menjadikan riwayat proyek sebagai sumber informasi yang berharga!

• Buat baris subjek tetap singkat dan gunakan kalimat perintah.
• Gunakan isi commit untuk menjelaskan 'mengapa' suatu perubahan dibuat.
• Pertimbangkan awalan jenis untuk pengategorian.
• Tautkan issue atau pull request untuk memberikan konteks.

Selamat melakukan commit!