Commit adalah hal yang penting dalam tracking perubahan repository git, akan sangat baik jika commit message ditulis dengan struktur yang baik dan mudah dibaca.
Tulisan ini mengambil referensi dari Vue Commit Convention.
Struktur Commit Message
<type>(<scope>): <subject>
<type>
Type bisa berisi dengan feat
, fix
, refactor
, test
, dan etc. Disarankan untuk menggunakan feat
, fix
untuk perubahan yang related dengan task tertentu. Selain yang related dengan task bisa menggunakan docs
, refactor
, test
dan etc.
docs : project setup guideline
<scope> [optional]
Scope digunakan untuk menentukan cakupan tempat commit dilakukan, atau bisa juga dengan melampirkan nomor tiket task yang related dikerjakan.
feat(#123) : add api for shopping cart
<subject>
Subject melampirkan deskripsi commit atau perubahan yang dilakukan, pastikan mudah dipahami dan menggambarkan perubahan tersebut.
Tips :
- Menggunakan bahasa inggris
- Usahakan menulis deskripsi dengan singkat namun mudah dipahami
Recommendations :
chore
feat
fix
docs
refactor
release
build
revert