Menulis pesan commit yang tidak menyebalkan.

Menulis pesan commit yang tidak menyebalkan.

Inget, lo engga bekerja sendiri (terutama dalam hal membangun perangkat lunak) bro.

·

2 min read

VCS— V̶i̶d̶e̶o̶ ̶C̶a̶l̶l̶ ̶S̶y̶a̶r̶i̶a̶h̶ Version Control System, sudah menjadi makanan kita (para developer? programmer? software engineer? whatever you name it) khususnya dalam hal membangun r̶u̶m̶a̶h̶ t̶a̶n̶g̶g̶a̶ perangkat lunak.

Oke, cukup bercandanya, sekarang coba serius.

Tapi nih, sebelum ke inti tulisan ini, coba perhatikan tangkapan layar commit gue (dan beberapa temen gue) di bawah ini:

Pesan commit dengan gaya..PNG

Gimana-gimana? mual ga lo liatnya? hahaha.

Selain mual diliat dan menyebalkan, pesan commit di atas juga terkesan kurang jelas (terlalu umum) & tidak rapi bukan? maka dari itu gue mencoba cari tau apakah ada penulisan pesan commit yang lebih "keren", dan setelah gue mencari kesana-kemari (aseeek), gue menemukan repositorynya si Angular.

Yang mana intinya, tim Angular punya format sendiri dalam hal penulisan pesan commit.

Kira-kira begini format yang mereka gunakan:

  • build: Perubahan yang memengaruhi sistem build atau dependensi eksternal (contoh: gulp, broccoli, npm)
  • ci: Perubahan pada file dan skrip konfigurasi CI kita (contoh: Circle, BrowserStack, SauceLabs)
  • docs: Hanya dokumentasi yang berubah (like readme i guess?)
  • feat: Misal habis nambahin fitur baru, pakai pesan ini
  • fix: Perbaikan bug
  • perf: Perubahan kode yang meningkatkan kinerja (performa)
  • refactor: Perubahan kode yang tidak memperbaiki bug atau menambahkan fitur
  • test: Menambahkan tes yang hilang atau memperbaiki tes yang sudah ada

Selain format di atas, mereka juga punya aturan, seperti:

  • gunakan kalimat imperative, present tense
  • jangan gunakan huruf kapital di awal kalimat
  • dan yang terakhir, jangan pakai titik (.) di akhir kalimat

Punya gambaran? Lebih keren & rapi bukan?.

Sebagai penutup, gue membuat tulisan ini karena gue merasa pesan commit gue yang mostly ada di github gue itu jelek banget, parah lah.

Nah, dengan gue (hmm mungkin lo juga?) yang sudah mengetahui ada penulisan pesan commit yang lebih baik, tentunya ini sangat membantu gue dalam hal penulisan commit kedepannya dan pembacaan commit suatu project (fyi, banyak yang pakai format ini juga btw).

Selain dua hal tersebut, ada satu hal lagi yaitu, temen lo engga kesel pas baca pesan commit yang lo tulis.

Thank you for comming and drink your water now.