Commit mesajları için template kullanımı

Daha anlaşılır ve daha işe yarar commit mesajı yazmak ister misiniz?

Armağan Amcalar’ın tweet’inde çok işe yarayacak bir blog post sonrası, commit template nasıl yapılırı anlatmak istedim.

git commit dediğinizde karşınıza gelen mesaj yazma ekranında, git tarafından hazır gelen mesaj şablonuna ek yapabiliriz.

git config --global commit.template ~/.git_commit_template

ile, bundan böyle yazacağımız mesajlar için önceden hazırlanmış bir şablon kullanmasını söyleriz git’e. ~/.git_commit_template dosyasına baktığımıza;

# If applied, this commit will...

# Why is this change being made?

# Provide links to any relevant tickets, URLs or other resources
  1. Bu commit’in ne yaptığını anlatır.
  2. Neden bu değişikliğe ihtiyaç vardı?
  3. Eğer ilgili bir ticket ya da link varsa yazılır.

İlgili post’daki örnek:

# If applied, this commit will...
Provide a Fabric task for installing Puppet modules

# Why is this change being made?
This change consolidates all project tasks in the fabfile.py and
means we can get rid of the make file

# Provide links to any relevant tickets, URLs or other resources
Fixes item:234
  1. Puppet modülleri için Fabric taskları sağlıyor
  2. Bu sayede artık make file kullanmaya gerek kalmıyor
  3. 234 numaralı issue fixlendi

Bu mantık içinde, takımdaki arkadaşların rahat anlayacağı bir şablon geliştirip, commit mesajlarını daha anlamlı hale getirebiliriz. Aynı zamanda bu tarz hareketler bize de hatırlatma anlamında faydalı olur.