Etkili, Yararlı Bir Git Taahhüt Mesajı Nasıl Yazılır?

Taahhüt mesajları, Git gibi bir sürüm kontrol sistemindeki her bir taahhüdün kısa açıklamalarıdır. Proje dosyalarınızda değişiklik yaptığınızda, bunların ne işe yaradığını veya bunları neden yaptığınızı açıklayan bir mesaj vermelisiniz.

Taahhüt mesajları, bir belgeleme ve iletişim biçimi olarak hizmet eder. Bir projenin açık ve düzenli sürüm geçmişini korumada çok önemli bir rol oynarlar. İyi taahhüt mesajları yazmayı öğrenin ve ekibinizin diğer üyeleri çalışmanızı daha da fazla takdir edeceklerdir.

İyi Bir Taahhüt Mesajının Yapısı

İyi bir taahhüt mesajı örneği dört bölümden oluşur: Tür, Açıklama, Gövde ve Altbilgi.

Şöyle:

: 
[isteğe bağlı gövde]
[isteğe bağlı alt bilgi]

Tip

Tür, mevcut taahhütte yapılan değişikliğin türünü açıklar. Koşullarınıza uygun olan herhangi bir sistemi kullanabilirsiniz. Örneğin, örnek kullanımın yanı sıra, her bir değişiklik türünün sinyalini vermek için kullanabileceğiniz bazı örnek anahtar kelimeler aşağıda verilmiştir:

• başarı: Değişiklikleriniz yeni bir özellik sunar.
• düzeltmek: bir hatayı düzeltirsiniz.
• refactor: değişikliğiniz, bir hatayı düzeltmeden veya yeni bir özellik eklemeden kodu yeniden düzenler.
• Ölçek: testle ilgili herhangi bir değişiklik yaparsınız. Örneğin, ne zaman Jest ile testler yaz veya herhangi biri diğer test çerçevesi sen seç.
• zevksiz iş: bir düzeltme, özellik veya testle ilgisi olmayan değişiklikler. Örneğin, bağımlılıkların güncellenmesi.
• dokümanlar: belgeleri güncellediğinizde.
• stil: boşluk ekleme, eksik noktalı virgül vb. gibi kodun anlamını etkilemeyen değişiklikler.
• mükemmel: performans iyileştirmeleriyle ilgili değişiklikler.
• inşa etmek: derleme dosyalarını etkileyen değişiklikler yaptığınızda.
• ci: sürekli entegrasyonla ilgili değişiklikler.
• geri almak: önceki bir taahhüde geri dönerken.

Tanım

Bir taahhüt mesajının "açıklaması", taahhütte yapılan değişikliklerin kısa ve açıklayıcı bir özetidir. Taahhüdün özünü yakalayan bir başlık görevi görür.

Açıklama yazarken aşağıdakileri aklınızda bulundurun:

• Bir bakışta taahhüdü açıklayacak kadar net ve spesifik hale getirin.
• Kısa ve öz yapın. İdeal olarak, 50 karakter veya daha azıyla sınırlandırmak en iyisidir.
• Zaten yapılmış değişiklikleri açıklıyor olsanız bile, şimdiki zamanda yazın.
• Yazarken emir kipinden yararlanın.
• Büyük harfle başlayın.
• Bir nokta ile bitirmeyin.

Örneğin:

feat: Ana sayfa için karanlık mod geçişini uygulayın

Bu örnek, bir taahhüdün açıklamasını nasıl yazabileceğinizi gösterir. karanlık modu uygular. Bu kullanır başarı yazın çünkü yeni bir özellik sunar.

Gövde (Opsiyonel)

Bir taahhüt mesajının gövde bölümü, taahhütte yapılan değişiklikler hakkında ek ayrıntılar ve bağlam sağlar. Her zaman bir yapıya ihtiyacınız olmayacak, ancak daha fazla bilgi sağlamaya, bir değişikliğin gerekçesini açıklamaya veya herhangi bir teknik hususu açıklamaya yardımcı olabilir.

Bir taahhüt mesajının gövde bölümünü yazarken dikkat edilmesi gereken bazı noktalar şunlardır:

• Git asla metni otomatik olarak kaydırmaz, bu nedenle gövdeyi yazarken metni manuel olarak 72 karaktere kaydırır. Bu, Git'e metni girintilemek için yeterli alan sağlayarak metni daha okunabilir hale getirir.
• Değişiklikte ne olduğunu, değişikliği neden yaptığınızı ve değişikliğinizin arkasındaki mantığı açıklamak için gövdeyi kullanın.
• Açıklama satırı ile gövde arasında bir satır boşluk bırakmalısınız. Bu, Git'in aralarında ayrım yapmasını sağlar.
• İşlem, birden çok değişiklik getiriyorsa veya kod tabanının farklı alanlarını etkiliyorsa, değişiklikleri parçalamak için madde işaretleri veya paragraflar kullanmayı düşünün. Bu, okunabilirliği artırır ve okuyucuların taahhüdün farklı yönlerini anlamalarına yardımcı olur.

Örneğin:

feat: GitHub'ı OAuth sağlayıcısı olarak ekleyin
Kesintisiz etkinleştirmek için GitHub'ı bir OAuth sağlayıcısı olarak entegre edin 
GitHub hesaplarıyla kimlik doğrulama.
- GitHub API ile OAuth kimlik doğrulama akışını uygulayın
- GitHub kimlik doğrulaması için gerekli uç noktaları ve ayarları yapılandırın
- Kullanıcı arayüzünü GitHub oturum açma seçeneğini içerecek şekilde güncelleyin

Yukarıdaki örnek, ekleyen bir özellik için iyi bir Git taahhüt mesajını gösterir. OAuth sağlayıcısı olarak GitHub uygulamanıza Bu taahhüt iletisinde kısa bir özet satırı (50 karakter veya daha az), daha ayrıntılı bir açıklayıcı metin (yaklaşık 72 karaktere kadar sarılmış) ve ek bilgi için madde işaretleri bulunur.

Bir taahhüt mesajındaki alt bilgi bölümü, taahhütle ilgili ek bilgiler veya meta veriler sağlayan isteğe bağlı bir bölümdür. Tipik olarak, boş bir satırla ayrılan gövde bölümünden sonra yerleştirilir. Alt bilgi, ilgili konulara, etiketlere veya özel notlara yapılan referanslar gibi çeşitli bilgi türlerini içerebilir.

Sorunlara, çekme isteklerine veya diğer ilgili öğelere atıfta bulunurken, projenizin sorun izleme sisteminin gerektirdiği uygun sözdizimini veya biçimi kullanın. Bu, referansların uygun şekilde tanınmasını ve bağlantılandırılmasını sağlar.

Örneğin:

feat: GitHub'ı OAuth sağlayıcısı olarak ekleyin
Kesintisiz etkinleştirmek için GitHub'ı bir OAuth sağlayıcısı olarak entegre edin 
GitHub hesaplarıyla kimlik doğrulama.
- GitHub API ile OAuth kimlik doğrulama akışını uygulayın
- GitHub kimlik doğrulaması için gerekli uç noktaları ve ayarları yapılandırın
- Kullanıcı arayüzünü GitHub oturum açma seçeneğini içerecek şekilde güncelleyin
Çözer: #123
Ayrıca bakınız: #456, #789

Altbilgi, ilgili sorun #123'e atıfta bulunur ve ek bağlam için diğer ilgili sorunlardan #456 ve #789 bahseder.

Taahhüt Mesajını Ekleme

kullanarak taahhüt mesajları yazabilirsiniz. -M işareti ve ardından tırnak içine alınmış taahhüt mesajı (isteğe bağlı ancak önerilir).

bu -M flag, genellikle tür ve açıklama içeren kısa taahhüt mesajları için idealdir.

Örneğin:

git commit -m "görev: linter'i ESlint olarak değiştir"

Ancak, taahhüt mesajınız gövde ve altbilgi gibi daha fazla ayrıntı gerektirdiğinde, taahhüdü bir metin düzenleyicide veya IDE'de yazmanız daha iyi olur.

Alternatif olarak, bir metin dosyasına uzun taahhüt mesajları yazabilir ve --dosya metin dosyasının içeriği olarak taahhüt mesajlarını belirtmek için bayrak.

Örneğin:

git commit --file commit_message.txt

Yukarıdaki komutu çalıştırdığınızda git, dosyanın içeriğini taahhüt mesajı olarak kullanacaktır.

Daha uzun bir mesaj yazmak için git'e varsayılan düzenleyicinizi açmasını da söyleyebilirsiniz. GIT_EDITOR veya EDITOR ortam değişkenini ayarladıysanız, çıplak çalıştırdığınızda git o programı açacaktır. git taahhüdü emretmek.

Neden İyi Taahhüt Mesajları Yazmalısınız?

İyi taahhüt mesajları yazmak, etkili işbirliği ve kod bakımı için çok önemlidir. Net ve açıklayıcı mesajlar, anlamaya, hata ayıklamaya ve kod incelemelerine yardımcı olur. Hatta proje belgelerine veya sürüm notlarına katkıda bulunabilirler.

Bilgi paylaşımı, sorunsuz katılım ve sürüm kontrolünü destekler. Kaliteli taahhüt mesajlarına öncelik vermek, geliştirme süreçlerini geliştirir ve kod tabanının sürdürülebilirliğini sağlar.