Conventional Commits Kullanımı ve Commit Mesajı Yönergeleri

Conventional Commits, bir yazılım projesinin geçmişinin temiz, tutarlı ve anlaşılır olmasını sağlamak amacıyla kullanılan bir konvansiyondur. Bu yöntem, commit mesajlarını standart bir formata oturtarak, proje geçmişinin daha iyi organize edilmesini ve sürüm yönetiminin daha etkili bir şekilde yapılmasını sağlar.

Commit Türleri

Commit mesajları, yapılan değişikliğin türünü belirtmek için belirli anahtar kelimelerle başlar. Aşağıda en yaygın commit türleri açıklanmıştır:

feat: Yeni bir özellik eklenmesini ifade eder. Bu tür commit'ler, projeye eklenen yeni işlevsellikleri kapsar.
- Örnek: "feat: added user login system"
fix: Bir hatanın düzeltilmesini ifade eder. Bu commit türü, mevcut bir işlevsellikteki hataların giderilmesi için kullanılır.
- Örnek: "fix: fixed error in login form"
docs: Sadece dökümantasyon değişikliklerini ifade eder. Kodda herhangi bir değişiklik yapılmadan yalnızca dökümantasyonun güncellenmesi için kullanılır.
- Örnek: "docs: API documentation updated"
style: Kodun anlamını etkilemeyen değişiklikleri kapsar. Bu tür commit'ler, boşluk ekleme, formatlama veya noktalama işaretlerinin düzeltilmesi gibi değişiklikler için kullanılır.
- Örnek :"style: code spaces organized"
refactor: İşlevsel bir değişiklik yapmadan kodun yeniden yapılandırılmasını ifade eder. Kodun daha okunabilir, sürdürülebilir veya performanslı hale getirilmesi amacıyla yapılan değişiklikler için kullanılır.
- Örnek: "refactor: login process code reshuffled"
test: Eksik testlerin eklenmesi ya da mevcut testlerin düzeltilmesi için kullanılır. Bu commit türü, test süreçlerini geliştirmek için yapılır.
- Örnek: "test: unit tests added for the login process"
chore: Build süreci ya da yardımcı araçlarda yapılan değişiklikleri ifade eder. Bu tür commit'ler, kod üzerinde doğrudan etkisi olmayan, ancak projenin yapısı ve araçlarıyla ilgili değişiklikler için kullanılır.
- Örnek: "chore: CI/CD configuration updated"

Commit Mesajı Yönergeleri

Commit mesajları, hem proje geçmişinin takip edilebilirliğini artırmak hem de ekip içi iletişimi güçlendirmek için belirli bir formatta yazılmalıdır. Aşağıda bu mesajların nasıl yazılması gerektiğine dair yönergeler bulunmaktadır:

1. Subject (İlk Satır)

Tür ile başlayın: Commit mesajınızın ilk satırı, yukarıda belirtilen commit türlerinden biriyle başlamalıdır (örneğin, feat, fix, docs).
Kısa ve emir kipinde bir açıklama kullanın: İlk satır, 50 karakteri geçmeyecek şekilde kısa ve öz bir açıklama içermelidir. Bu açıklama, yapılan değişikliğin ana fikrini ifade etmelidir.
- Örnek: "feat: kullanıcı giriş sistemi eklendi"

2. Body (Detaylı Açıklama)

Boş bir satır bırakın: Subject satırından sonra bir boş satır ekleyin. Bu, commit mesajının okunabilirliğini artırır.
Değişiklikleri açıklayan 2-3 cümle yazın: Bu bölümde yapılan değişikliklerin detaylarını açıklayın. Değişikliklerin neden yapıldığını ve ne gibi etkilerinin olacağını belirtin.
Her satırın 100 karakterin altında olmasına dikkat edin: Gerekirse satırları manuel olarak kırarak, her satırın 100 karakterin altında kalmasını sağlayın. Bu, commit mesajlarının okunabilirliğini artırır ve araçlar tarafından doğru bir şekilde görüntülenmesini sağlar.
- Örnek:
  feat: added user login system A new login page and authentication process have been added to allow users to log into the system. This change aims to improve the user experience and ensure security

Commit Mesajı Örnekleri

Aşağıda, Conventional Commits kurallarına uygun örnek commit mesajları verilmiştir:

git commit -m "feat: added user login system"
git commit -m "fix: fixed error in login form"
git commit -m "docs: API documentation updated"
git commit -m "style: code spaces organized"
git commit -m "refactor: login process code reshuffled"
git commit -m "test: unit tests added for the login process"
git commit -m "chore: CI/CD configuration updated"

Commit Mesajlarının Faydaları

Proje Geçmişini Anlaşılır Hale Getirir: Conventional Commits ile yazılan commit mesajları, proje geçmişinin kolayca anlaşılmasını sağlar. Bu, özellikle proje büyük ve karmaşık hale geldikçe önem kazanır.
Sürüm Yönetimini Kolaylaştırır: Bu kurallar, sürüm numaralarının otomatik olarak belirlenmesine yardımcı olur. Örneğin, feat commit'leri MINOR sürüm güncellemelerine, fix commit'leri ise PATCH sürüm güncellemelerine neden olabilir.
İletişimi Güçlendirir: İyi yazılmış commit mesajları, ekip üyeleri arasında daha iyi iletişim sağlar. Herkes, hangi değişikliklerin yapıldığını ve bu değişikliklerin neden yapıldığını net bir şekilde anlayabilir.

Last modified: 23 August 2024