Commit Mesajlarını Standartlaştırma — Github #6

İsmet Kizgin
3 min readNov 18, 2023

--

Git, projelerimizi versiyonlama ve geliştirme süreçlerini takip etme konusunda mükemmel bir araçtır. Ancak, bu güçlü aracın etkili bir şekilde kullanılabilmesi için, attığımız commit mesajlarını standartlaştırmak önemli bir adımdır. Her bir commit aslında birer versiyonu temsil eder ve bu nedenle commit mesajları, projenin geçmişini anlamak, hataları düzeltmek ve takım çalışması için kritik bir rol oynar.

Neden Commit Mesajlarını Standartlaştırmalıyız?

Geçmişi Anlamak: Projenin geçmişine dönük bir bakış, hangi değişikliklerin yapıldığını anlamamıza yardımcı olur. İyi yazılmış commit mesajları, geçmişte yapılan değişikliklerin nedenlerini hızlıca anlamamıza olanak tanır.

Hata Ayıklama: Standartlaştırılmış commit mesajları, hata ayıklama sürecini hızlandırabilir ve geliştiricilere yol gösterici bilgiler sağlayabilir.

Takım Çalışması: Birden fazla geliştiricinin aynı projada çalıştığı durumlarda, standartlaştırılmış commit mesajları, ekibin birbirini anlamasını kolaylaştırır.

Commit Mesajları İçin Temel İlkeler

  1. Commit mesajları öz ve anlamlı olmalı.
  2. Emir kipi veya geçmiş zaman kipi kullanılarak yazılması önerilir. (Not: Ben tercihen emir kipi kullanmaya özel gösteriyorum.)
  3. Yapılan değişikliği temsil eden etiketler commit mesajının başına eklenmeli. (örn: feat, fix, refactor vb.)
  • feat: Yeni bir özellik eklediğinizde bu commit türünü kullanmalısınız.
feat: add new contact page with form and details.
feat([issue Number]): add new contact page with form and details.
  • fix: Var olan bir hatayı düzelttiğinizde veya mevcut bir özelliği düzelttiğinizde bu commit türünü kullanmalısınız.
fix: resolve issue with contact form submission on the contact page.
fix([issue Number]): resolve issue with contact form submission on the contact page.
  • refactor: Kodunuzu yeniden düzenlediğinizde ve performansı artırmak veya daha iyi bir tasarım elde etmek amacıyla kod değişiklikleri yaptığınızda bu commit türünü kullanmalısınız.
refactor: simplify and optimize code structure in the contact page.
refactor([issue Number]): simplify and optimize code structure in the contact page.
  • perf: Kodunuzun performansını artırmak için yapılan değişikliklerde bu commit türünü kullanmalısınız.
perf: contact page removal for improved loading speed.
perf([issue Number]): contact page removal for improved loading speed.
  • style: Sadece görsel değişikliklerle ilgili olmayan, kodunuzun stilini veya formatını düzenlediğinizde bu commit türünü kullanmalısınız. Boşluklar, girintiler veya kod yapısı gibi.
style: update color scheme for the contact form page.
style([issue Number]): update color scheme for the contact form page.
  • ci: Sürekli entegrasyon süreçleriyle ilgili değişikliklerde bu commit türünü kullanmalısınız.
ci: update CI configuration for contact page refactor.
ci([issue Number]): update CI configuration for contact page refactor.
  • doc: Projedeki belgelerle ilgili değişikliklerde bu commit türünü kullanmalısınız.
doc: update README with installation instructions.
doc([issue Number]): update README with installation instructions.
  • build: Projenin derleme süreçleriyle ilgili değişikliklerde bu commit türünü kullanmalısınız.
build: upgrade dependencies to Node.js v14.0.0.
build([issue Number]): upgrade dependencies to Node.js v14.0.0.
  • revert: Önceki bir commit’i geri almak için bu commit türünü kullanmalısınız.
revert: revert recent changes to fix issue with login.
revert([issue Number]): revert recent changes to fix issue with login.
  • test: Test senaryolarında veya test altyapısında değişiklikler yaptığınızda bu commit türünü kullanmalısınız.
test: add unit tests for user authentication module.
test([issue Number]): add unit tests for user authentication module.

Yararlı Olabilecek Kaynaklar

Github Blog Serisi

9 stories

--

--