Git menawarkan strategi percabangan yang fleksibel, tetapi apa artinya? Dengan kata sederhana, strategi percabangan adalah seperangkat aturan, konvensi yang membantu tim dan pengembang – mereka dapat mengikuti aturan dan konvensi ini untuk membuat cabang baru, alurnya, dll.
Tidak menggunakan konvensi penamaan yang sesuai menyebabkan kebingungan dan memperumit tim pemeliharaan kode. Kami tidak dapat mengabaikan praktik terbaik Git dalam konvensi penamaan percabangan.
Strategi percabangan Git memungkinkan pemisahan pekerjaan. Secara garis besar, kita dapat membagi cabang Git menjadi dua kategori:Cabang Reguler &Sementara.
Cabang Git Reguler
Cabang-cabang ini akan tersedia di repositori Anda secara permanen. Konvensi penamaan mereka sederhana dan lugas.
- Pengembangan (pengembangan ) adalah cabang pengembangan utama. Ide cabang dev adalah membuat perubahan di dalamnya dan membatasi pengembang untuk membuat perubahan apa pun di cabang master secara langsung. Perubahan di cabang dev menjalani peninjauan dan, setelah pengujian, digabungkan dengan cabang master.
- Tuan (Tuan ) adalah cabang default yang tersedia di repositori Git. Itu harus stabil sepanjang waktu dan tidak mengizinkan check-in langsung. Anda hanya dapat menggabungkannya setelah peninjauan kode. Semua anggota tim bertanggung jawab untuk menjaga master tetap stabil dan up-to-date.
- QA (QA ), atau cabang pengujian, berisi semua kode untuk pengujian QA dan pengujian otomatisasi dari semua perubahan yang diterapkan. Sebelum perubahan apa pun masuk ke lingkungan produksi, ia harus menjalani pengujian QA untuk mendapatkan basis kode yang stabil.
Cabang Git Sementara
Seperti namanya, ini adalah cabang yang dapat dibuat dan dihapus saat dibutuhkan. Mereka dapat sebagai berikut:
- Perbaikan Bug
- Perbaikan Terbaru
- Cabang Fitur
- Cabang Eksperimental
- Cabang WIP
Ada banyak format dan konvensi penamaan yang direkomendasikan oleh para ahli untuk cabang sementara.
Berikut adalah alur kerja sederhana dari cabang Git.
Konvensi Penamaan Percabangan Git
Dalam artikel ini, saya akan meninjau dan membagikan tujuh konvensi penamaan terbaik yang pernah saya gunakan secara pribadi untuk memastikan efisiensinya.
1. Mulai nama cabang dengan kata Grup
Ini adalah salah satu praktik terbaik. Kata grup dapat berupa apa saja yang cocok dengan alur kerja Anda.
Saya suka kata-kata pendek seperti berikut:
Kutu – Bug yang perlu segera diperbaiki
WIP – Pekerjaan sedang berlangsung, dan saya tahu ini tidak akan segera selesai
Dengan melihat nama cabang, Anda dapat memahami tentang apa cabang Git ini dan tujuannya.
Lihat contoh di bawah ini:
- bug-logo-alignment-issue – pengembang mencoba memperbaiki masalah penyelarasan logo;
- wip-ioc-container-added – cabang berhubungan dengan tugas untuk menambahkan wadah IoC yang sedang berlangsung.
2. Gunakan ID Unik dalam nama cabang
Anda dapat menggunakan Id pelacak masalah di nama cabang Anda. Saya lebih suka metode ini ketika saya bekerja untuk memperbaiki beberapa bug. Misalnya:
wip-8712-add-testing-module
Nama menunjukkan bahwa cabang berlaku untuk tugas menambahkan modul pengujian, ID pelacakan masalah adalah 8712, dan pekerjaan sedang berlangsung.
Satu lagi keuntungan menggunakan ID pelacakan eksternal dalam nama cabang adalah kemungkinan untuk melacak kemajuan dari sistem eksternal.
3. Gunakan Tanda hubung atau Garis miring sebagai Pemisah
Banyak pengembang menggunakan garis miring sebagai pemisah, dan banyak yang menggunakan tanda hubung. Yang mana yang akan digunakan – tergantung pada preferensi Anda dan tim Anda.
Menurut pendapat saya, tanda hubung membuat nama lebih nyaman dibaca, jadi ini adalah pemisah yang cocok untuk nama cabang. Anda dapat menggunakan garis miring, tanda hubung, dan garis bawah. Intinya konsisten.
Ada dua keuntungan utama menggunakan pemisah dalam nama cabang:
- Ini meningkatkan keterbacaan dan membantu menghindari kebingungan;
- Mempermudah pengelolaannya, terutama jika Anda berurusan dengan banyak cabang.
Contoh 1. Nama cabang Git tanpa pemisah:
fiturupgradejqueryversionloginmodule
Contoh 2. Dengan menambahkan pemisah (dalam hal ini, ini adalah garis bawah), Anda membuat nama cabang Git dapat dibaca:
fitur_upgrade_jquery_version_login_module
4. Cabang Git dengan Nama Penulis
Banyak perusahaan lebih memilih untuk menambahkan nama penulis ke dalam nama cabang sesuai dengan format di bawah ini:
<author>_<branch-type>_<branch-name>Mis., rajeev.bera_feature_new-experimental-changes
Metode ini memudahkan pelacakan pekerjaan dan kemajuan pengembang yang berbeda dengan sistem tambahan.
5. Hindari menggunakan angka saja
Beberapa pengembang hanya menggunakan ID masalah dalam nama cabang, yang tidak membantu dalam kemajuan pekerjaan.
Misalnya, ada nama cabang 9912 – apa yang harus diberitahukan oleh angka ajaib ini kepada kita? Ini hanya berarti lebih banyak kebingungan dan risiko kesalahan, terutama selama penggabungan dengan cabang git lainnya.
6. Hindari menggunakan semua konvensi penamaan secara bersamaan
Mencampur dan mencocokkan semua konvensi penamaan cabang Git bukanlah praktik terbaik. Itu hanya menambah kebingungan dan memperumit keseluruhan proses.
Sebuah tim harus memutuskan konvensi penamaan untuk digunakan dalam pekerjaan sekali, dan menaatinya. Konsistensi adalah hal yang paling penting.
7. Hindari nama deskriptif panjang untuk cabang berumur panjang
Kualitas penting dari nama cabang adalah harus tepat dan informatif. Mari kita lihat beberapa contoh lagi:
wip_login_module_which_will_used_in_the_public_website
wip_login_module_which_will_used_in_the_internal_website
Di sana, nama cabangnya panjang dan detail. Hal ini tidak perlu. Sebagai gantinya, Anda dapat menggunakan varian berikut:
wip_feature_login_module
Nama ini pendek, tetapi menjelaskan tujuan cabang ini.
Kesimpulan
Model percabangan Git sangat kuat, tetapi Anda perlu mengelola cabang dengan benar dan efektif. Salah satu faktor yang diperlukan adalah mengikuti konvensi yang sama oleh semua tim, khususnya – konvensi penamaan untuk repositori lokal.
Untuk memastikan tim Anda menggunakan konvensi yang disepakati, terapkan standar. Salah satu cara termudah adalah dengan menggunakan kait Git, seperti kait pra-komit. Saya harap ini akan memberi Anda gambaran tentang model percabangan Git dan konvensi penamaannya.
