Mengapa standar pesan pada saat commit Git penting untuk keberlangsungan development? Dalam pengembangan sebuah aplikasi, penggunaan alat version control seperti Git telah menjadi standar. Git memungkinkan tim pengembang untuk bekerja secara kolaboratif, melacak perubahan kode, dan mengelola project dengan efisien. Di antara praktik terpenting dalam menggunakan Git adalah memberikan deskripsi atau pesan yang jelas dan bermakna pada setiap commit yang dilakukan.
Daftar Isi
Mengapa Standar Pesan Diperlukan saat commit?
1. Keterangan yang Jelas
Deskripsi yang diberikan pada setiap commit haruslah informatif dan jelas. Hal ini membantu pengembang lain dalam tim untuk memahami perubahan apa yang telah terjadi dalam commit tersebut tanpa harus memeriksa secara langsung detail kode yang berubah. Dengan demikian, deskripsi yang baik dapat menyajikan gambaran keseluruhan dari perubahan yang dilakukan, memberikan wawasan yang diperlukan kepada pengembang lain dalam tim.
2. Pelacakan Perubahan
Dengan memiliki deskripsi commit yang terperinci, tim pengembang dapat melacak sejarah perubahan kode dengan lebih efektif. Ketika tim perlu memeriksa kembali perubahan tertentu atau memahami alasan di balik suatu perubahan, deskripsi commit akan menjadi panduan yang berguna. Ini mempermudah proses audit dan memungkinkan pengembang untuk memahami evolusi kode dari waktu ke waktu.
3. Kolaborasi Efisien
Standar pesan pada saat commit juga mendukung kolaborasi yang efisien di antara anggota tim. Dengan deskripsi commit yang baik, anggota tim dapat dengan cepat memahami konteks perubahan yang dilakukan oleh rekan mereka. Hal ini memfasilitasi proses review kode, mempercepat penyesuaian pekerjaan, dan memastikan bahwa semua anggota tim tetap berada pada halaman yang sama dalam pengembangan proyek.
4. Mengatasi Konflik
Ketika terjadi konflik saat menggabungkan branch dalam Git, deskripsi commit dapat menjadi alat yang berguna. Dengan memahami perubahan yang telah dilakukan pada masing-masing branch, pengembang dapat membuat keputusan yang lebih tepat saat mengatasi konflik. Deskripsi commit membantu pengembang untuk mengevaluasi perubahan yang telah dilakukan dengan lebih baik, sehingga memungkinkan mereka untuk menentukan cara terbaik dalam menggabungkan kode.
Aturan Standar Pesan Commit
Jika kamu masih sering mengisi pesan commit seperti tulisan ‘done’, ‘finish’, ‘update’, dan lain-lain. Itu akan membuat kamu kesulitan sendiri di kemudian hari karena pesan yang tidak jelas. Mari untuk mengenal Conventional Commits. Conventional Commits adalah cara standar untuk menulis pesan commit di git. Dan di bawah ini merupakan standar pesan saat melakukan commit git.
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]Contoh Pesan Commit
Misalkan kamu telah membuat sebuah fitur baru yaitu login menggunakan SDK Google. Karena yang kamu coding adalah fitur baru, type yang di tulis adalah “feat” dan descriptionnya adalah “Login SDK Google”. Jadinya seperti ini:
feat: Login SDK GoogleApabila kamu habis memperbaiki error atau bugs validasi email pada saat register di project kamu. Jadinya seperti ini:
fix: prevent user registration with invalid email formatTipe-tipe Commit
Type commit memiliki beberapa jenis seperti di bawah ini:
- feat: Commit ini menambahkan fitur baru ke dalam kode, baik itu fitur untuk pengguna akhir atau fitur internal yang belum ada sebelumnya.
- fix: Commit ini memperbaiki masalah atau bug dalam kode, baik itu masalah kecil atau besar yang mengganggu fungsi aplikasi.
- refactor: Commit ini berkaitan dengan perubahan kode yang tidak menambahkan fitur baru atau memperbaiki bug, tetapi bertujuan untuk meningkatkan struktur, kebersihan, atau keterbacaan kode.
- perf: Commit ini menangani perbaikan kinerja dalam kode, seperti optimisasi algoritma atau penggunaan sumber daya yang lebih efisien.
- revert: Commit ini membatalkan atau mengembalikan perubahan sebelumnya dalam history commit. Ini digunakan ketika perubahan sebelumnya menyebabkan masalah atau tidak diinginkan.
- style: Commit ini berkaitan dengan perubahan yang hanya berpengaruh pada style atau tata letak kode, seperti perbaikan format, penambahan atau penghapusan spasi, atau perubahan nama variabel.
- build: Commit ini berkaitan dengan perubahan yang terkait dengan proses build, seperti konfigurasi build, dependensi, atau skrip build.
- chore: Commit ini berkaitan dengan tugas atau pekerjaan yang tidak terkait langsung dengan kode sumber atau pengguna akhir, misalnya pembaruan alat, perubahan konfigurasi, atau tugas administratif.
- ci: Commit ini berkaitan dengan konfigurasi atau perubahan terkait dengan Continuous Integration (CI) atau Continuous Deployment (CD), seperti skrip CI, integrasi dengan layanan CI, atau perubahan konfigurasi CI.
- docs: Commit ini berkaitan dengan perubahan dalam dokumentasi, seperti penambahan, pembaruan, atau perbaikan dokumen.
- test: Commit ini berkaitan dengan penambahan, pembaruan, atau penghapusan tes dalam kode, baik itu tes unit, integrasi, atau tes fungsional.
Baca Juga: Mengapa Seorang Programmer Harus Memahami SEO
Kesimpulan
Pastikan kamu mengisi deskripsi pada saat commit menggunakan bahasa Inggris, singkat padat dan konsisten. Karena deskripsi yang baik membantu tim pengembang untuk memahami perubahan yang terjadi dalam kode, melacak history perubahan dengan lebih baik, dan berkolaborasi secara efisien. Dengan mematuhi standar deskripsi yang baik, tim pengembang dapat meningkatkan transparansi, keterbacaan, dan efektivitas dalam pengelolaan kode sumber project mereka.
Sumber: https://www.conventionalcommits.org/en/v1.0.0/
