Tutorial Git : Cara Membuat Pesan Commit yang Baik

Facebook
Twitter
LinkedIn

Git adalah aplikasi open source sumber terbuka yang digunakan untuk melakukan kontrol versi terhadap proyek aplikasi. Mulai dari proyek berskala kecil sampai ke proyek berskala besar diusahakan untuk menggunakan Git, karena Git dapat mempercepat dan lebih efisien dalam melakukan kontrol versi dan kolaborasi.

Setiap kamu melakukan commit dengan Git, maka Git akan menyimpan state dari proyek yang kamu kerjakan. Memastikan kamu bisa kembali ke state tersebut jika terjadi masalah dalam proses update atau menambah state baru diatas state sebelumnya.

Setiap kali melakukan commit kita bisa mengisi pesan di dalam commit yang bisa dibaca oleh orang – orang yang ada di dalam proyek tersebut. Pesan tersebut berisi deskripsi singkat terhadap apa yang telah kamu lakukan dalam sebuah update. Tentunya kita tidak ingin pesan tersebut tidak dimengerti dan menimbulkan masalah di update selanjutnya. Kamu bisa mengisi pesan itu dengan teks apapun. Tapi kali ini aku mau membagikan tips dan trik untuk membuat pesan commit yang mudah dibaca oleh tim yang lain.

gitlab git
Pankaj Patel – Unsplash

Struktur pesan commit

Walaupun kamu bebas mengisi pesan commit tapi ini adalah struktur yang bisa kamu pakai bersama tim dalam mengisi pesan commit :

<tipe-commit>: <subjek>
<body>
<footer>

Sekarang kita jelaskan struktur diatas

<tipe-commit>

Tipe commit adalah jenis perubahan yang telah kamu lakukan. Tipe commit bisa kamu isi dengan:

  • feature: Jika kamu menambahkan fitur baru ke dalam proyek
  • fix : Jika kamu melakukan pembenahan terhadap bug yang diketahui
  • refactor : Jika kamu melakukan refactor terhadap berberapa bagian dari kode
  • test : Tuliskan jika kamu melakukan apapun terkait testing
  • docs : Tuliskan jika kamu melakukan apapun terkait dokumen – dokumen proyek

<subjek>

Tuliskan deskripsi singkat dari commit yang dilakukan dengan ketentuan penulisan sebagai berikut:

  • Berisi maksimal 50 karakter, pikirkan bahwa ini adalah judul dari pesan commit mu
  • Jelaskan secara singkat namun tepat sasaran
  • Jangan bertele – tele

<body>

Jelaskan perubahan apa yang kamu buat dan kenapa kamu membuatnya. Pastikan teks tidak lebih dari 80 karakter, anggota tim – mu biasanya malas membaca, jadi tuliskan sesingkat mungkin.

<footer>

Gunakan Footer untuk menjelaskan issue baru yang terjadi ketika perubahan selesai atau komentar, pemberitahuan dan peringatan pada developer dan tester lainya.

Contohnya, kamu bisa lihat dibawah:

fix: membenahi pengiriman email - form pendaftaran #20

Email saat ini memiliki limit yg menyebabkan pengiriman email gagal
Tolong tambahkan edit email pada pendaftaran

Kesimpulan

Sekarang kamu bisa membuat pesan commit yang lebih dimengerti oleh anggota tim-mu yang lain. Selamat mengerjakan proyek!

Baca Juga:

Muhammad Fajar Estu
Muhammad Fajar Estu
Fajar adalah seorang fullstack programmer yang sekarang bekerja sebagai .NET programmer. Memiliki pengalaman selama 3+ tahun di bidang programming web, mobile, API hingga aplikasi computer vision. Sekarang Fajar menulis artikel tutorial dan berbagi seputar dunia perkuliahan IT.

Tinggalkan Balasan

Alamat email Anda tidak akan dipublikasikan. Ruas yang wajib ditandai *