Gönderim İletileri için En İyi Uygulamalar

Projenizin geçmişine dönüp baktığınızı düşünün. Açık kayıt iletileri olmadan bu, boş sayfaları olan bir günlük okumaya benzer!

İyi kayıt iletileri, değişikliklerin neden yapıldığını, neyin değiştirildiğini ve bunların projeyi nasıl etkilediğini anlamak için çok önemlidir. Bu, sizin ve ekibinizin kodda hata ayıklamasına, kodu incelemesine ve yeni üyeleri ekibe kazandırmasına yardımcı olur.

Standart bir Git kayıt iletisinin iki ana bölümü vardır:

• Konu Satırı: Değişikliği özetleyen tek ve kısa bir satır.
• Gövde (İsteğe Bağlı): Konu satırından boş bir satırla ayrılan daha ayrıntılı açıklama.

Bunu bir e-posta gibi düşünün: hızlıca göz atmak için konu satırı, ayrıntılar için gövde.

Konu satırı en önemli bölümdür. Kurallar şunlardır:

• Kısa Tutun: 50-72 karakteri geçmesin.
• Emir Kipi: Geniş zamanlı bir fiille başlayın (ör. "Özellik ekle", "Özellik eklendi" veya "Özellik ekleniyor" değil).
• İlk Harfi Büyük Yazın: Okunabilirlik için standart uygulamadır.
• Nokta Koymayın: Konu satırını noktayla bitirmeyin.

İyi ve kötü konu satırlarından bazılarına bakalım:

• İyi: Fix: broken login button
• İyi: Feat: implement user profile page
• Kötü: Fixed a bug in the login system that was causing issues. (Çok uzun, geçmiş zaman)
• Kötü: updates (Çok belirsiz)

Açıklık ve kısalık hedefleyin!

Kayıt gövdesinde değişikliğin gerekçesini, bağlamını ve doğrudan koddan anlaşılmayan ayrıntıları açıklarsınız.

Değişikliğiniz konu satırının sağlayabileceğinden daha fazla açıklama gerektirdiğinde gövdeyi kullanın. Git araçlarında daha iyi okunabilmesi için satırları yaklaşık 72 karakterde bir bölün.

Gövdeyi yazarken:

• Değişikliğin yalnızca ne olduğunu değil, neden yapıldığını açıklayın.
• Uzlaşmaları veya tasarım kararlarını açıklayın.
• Olası yan etkilerden veya dikkat edilmesi gereken alanlardan söz edin.
• Konu ile gövde arasında boş bir satır bırakın.

Bu, gelecekte okuyacak kişiler için değerli bir bağlam sağlar.

İyi yapılandırılmış tam bir kayıt iletisi şöyle görünebilir:

Birçok ekip, konu satırının bir tür ön ekiyle başladığı bir kural benimser. Bu, değişiklikleri hızlıca kategorilere ayırmaya yardımcı olur.

Yaygın ön ekler şunlardır:

• feat: (yeni özellik)
• fix: (hata düzeltmesi)
• docs: (belge değişikliği)
• style: (kod stili, işlevsel değişiklik yok)
• refactor: (kodun yeniden düzenlenmesi)
• test: (testler ekleme)
• chore: (bakım, derleme süreci değişiklikleri)

Kayıtlarınızı projenizin yönetim sistemindeki ilgili sorunlara veya çekme isteklerine bağlamak iyi bir uygulamadır (ör. GitHub Issues veya Jira).

Bunu genellikle gövdede, kayıt iletinize Closes #123, Fixes #45 veya Refs #67 gibi ifadeler ekleyerek yapabilirsiniz. Bu işlem, kod değişikliklerinizi izlenen göreve otomatik olarak bağlar.

En iyi uygulamalara göre iyi yazılmış bir Git kayıt iletisinin özellikleri aşağıdakilerden hangileridir?

İyi hazırlanmış kayıt iletilerinin proje açıklığı ve iş birliği için hayati önem taşıdığını öğrendiniz. Bu en iyi uygulamaları izleyerek proje geçmişinizi değerli bir kaynağa dönüştürürsünüz!

• Konu satırlarını kısa tutun ve emir kipini kullanın.
• Değişikliğin 'neden' yapıldığını açıklamak için gövdeyi kullanın.
• Kategorilere ayırmak için tür ön eklerini değerlendirin.
• Bağlam sağlamak için sorunlara veya çekme isteklerine bağlantı verin.

İyi kayıtlar!