İyi bir commit mesajı yazmak, projenin geçmişini takip etmek ve işbirliği yapmak için önemlidir. Git üzerinden commit yaparken aşağıdaki kurallara dikkat edin.
- Kısa ve Öz Olmalı: Commit mesajınız mümkünse 50 karakterden kısa olmalıdır. İlk satır genellikle bir başlık olarak kullanılır.
- Başlık Açıklayıcı Olmalıdır: Başlık, değişikliğinizin ne yaptığını açıkça ifade etmelidir. “Bug düzeltme”, “Geliştirme” gibi genel ifadeler yerine, gerçek değişiklik hakkında bir bilgi içermelidir.
- Detaylı Açıklama: İlk satırın ardından boş bir satır bırakın ve daha fazla detay ekleyin. Bu kısımda değişikliklerin neden yapıldığı, nasıl yapıldığı ve hangi problemi çözdüğü gibi bilgiler yer alabilir.
- Özel Referanslar: Eğer bir hata takip numarası, proje yönetim aracı referansı veya diğer referanslar varsa, commit mesajında belirtmek faydalı olabilir.
- Imperative Form Kullanın: Commit mesajınızı olumlu bir dilde yazın ve genellikle emir kipini kullanarak ifade edin. Örneğin, “Fix bug” veya “Add feature” gibi.
Örnek bir commit mesajı:
Kullanıcı giriş ekranında oluşan hata düzeltildi
– Kullanıcı adı ve şifre doğrulaması sırasında ortaya çıkan bir hata düzeltildi.
– Hata, kullanıcıdan gelen boş karakterlerle ilgili bir sorunu çözerek düzeltildi.
– İlgili hata takip numarası: #123
Leave a Reply