Commit Mesajları Nasıl Yazılmalı?

Commit Mesajları Nasıl Yazılmalı?

Git commit ne iş yapar ve neden ihtiyaç duyarız?​

git commit komutu, bir git reposundaki değişikliklerin eklenmesi, silinmesi veya güncellenmesi işlemlerinin anlık bir görüntüsünü alarak kaydeder. Bu, bilgisayar oyunlarındaki oyun kaydetme işlemine benzer şekilde çalışır. Projemiz belirli bir aşamaya geldiğinde, git commit komutu ile ilerlememizi kaydederiz. Bu, projenin daha önceki sürümlerine dönülebilmesini sağlar ve işbirliği yaptığımız diğer geliştiricilerin çalışmalarını takip etmesine yardımcı olur.

Git commit mesajını yazmanın en basit yolu, git commit -m “commit mesajınız” komutunu kullanmaktır. Bu komut, değişikliklerin anlık bir görüntüsünü alarak depoya kaydeder ve “commit mesajınız” olarak adlandırılan açıklayıcı bir mesaj ile bu değişikliklerin ne olduğunu belirtir. Bu sayede, depodaki değişikliklerin ne zaman ve neden yapıldığı gibi bilgileri takip edebilir ve projenin daha önceki sürümlerine dönebilirsiniz. Ayrıca, commit mesajlarının açıklayıcı olması, projeye dahil olan diğer geliştiricilerin çalışmalarını takip etmelerine yardımcı olur ve projenin gelecekteki gelişimini kolaylaştırır.

Commit mesajı nedir?​

Commit mesajı, bir Git commit işlemi sırasında eklenen açıklayıcı bir metindir ve commit’i yazan geliştirici tarafından commit nesnesine eklenir. Commit mesajları, projedeki değişikliklerin ne olduğunu ve neden yapıldığını açıklamak için kullanılır. Bu sayede, projenin gelecekteki okuyucuları veya diğer geliştiricileri değişiklikleri anlayabilir ve projenin tarihini takip edebilir.

Commit mesajları, yazdığımız kodların anlaşılması için de önemlidir. Gelecekteki bir zamanda, kodlara tekrar baktığımızda yazdığımız eski kodları daha iyi anlamamızı sağlar. Commit mesajları genellikle bir başlık ve isteğe bağlı bir gövdeye sahiptir. Başlık, değişikliklerin özetini içerirken, gövde daha ayrıntılı bilgiler sağlayabilir. Doğru ve açıklayıcı commit mesajları, projenin gelişimini takip etmek ve projeyi diğer geliştiricilerle paylaşmak için çok önemlidir.

Neden kaliteli commit mesajı oluşturmalıyız​

Commit`lerimiz kod değişikliklerimizin anlık bir görüntüsüdür ve bu değişikliklerin açıklamasını içeren commit mesajları ile birlikte saklanır. Bu nedenle, iyi yazılmış commit mesajları kodumuzun ne iş yaptığını daha sonra bakan kişilerin anlamasına yardımcı olur. Eğer kötü veya yetersiz commit mesajları yazarsak, kodumuzda bir hata oluştuğunda bu hatayı bulmak için eski commit mesajlarına bakmamız gerekebilir. Bu durumda, hataları bulmak için tüm kodu okumamız gerekebilir ve bu zaman alıcı ve zahmetli bir işlemdir. Ayrıca, aylar önce yazılmış bir kodun ne iş yaptığını anlamak zor olabilir. İyi yazılmış commit mesajları, hataların nerede olduğunu kolayca bulmamızı ve kodun ne yaptığını anlamamızı sağlar. Bu sayede, hataları düzeltebilir ve kodu daha iyi bir duruma getirebiliriz.

Genel commit mesajları yazma kuralları​

Commit mesajları, genel kural olarak, başlık kısmının 50 karakteri geçmeyecek şekilde kısa, açıklayıcı ve tek satır olmalıdır. Ardından boş bir satır bırakılmalı ve daha ayrıntılı açıklayıcı metin isteğe bağlı olarak yazılabilir. Eğer commitinizde birden fazla değişiklik varsa, tek bir kısa mesajla commit yazmak zor olabilir. Bu durumda değişiklikleri birden fazla commite bölerek işinizi kolaylaştırabilirsiniz. Örneğin, 3 değişiklik yaptığınız bir committe, 2 tanesi sorunsuz çalışıyor ama bir tanesi ileride hata nedeni oluyorsa, bu hatayı düzeltmek için commit atmadan önceki orijinal haline döndüğünüzde, çalışan 2 değişiklik durumunu da silmek zorunda kalabilirsiniz. Bu durumu yaşamamak için değişiklikleri mümkün olduğunca küçük parçalar halinde commitlemeniz önerilir.

1. Kısa ve öz olsun

• Bir committen daha az değişiklik bulunması mesajı kısa yazmanıza yardımcı olacaktır.
• Mesajınızın açık ve anlaşılır olması için tek bir konuda odaklanın ve olabildiğince sade tütün.

2. Şimdiki zaman ve emir kipi kullanın

• “x metodunu asenkron yap” gibi.

3. Kisa bir başlık ekleyin

• Başlık 50 karakterden az olmalı.
• Çoğu kod yönetim sistemleri, commit mesaj başlıkları için sınırlı bir alan sağlar ve bu genellikler 50 karakterle sınırlıdır, bu nedenle mesajinizin tamamının görünmesi için 50 karakterden az olması gerekmektedir.
• Basliginizin kısa olması diğer ekip uyelerinizin hızlı bir şekilde değişiklikler hakkında bilgi edinmesine yardımcı olur.
• Başlıkları başlık gibi yani kelimelerin baş harflerini büyük yazın.

4. İsteğe bağlı bir gövde ekle

• Başlık ve gövde arasında bir boş satır olmalıdır.
• Gövde satır uzunluğu 72 karakterden az olmalı.
• Değişikliğin ne ve neden ihtiyaç olduğunu açıklayan bir mesaj yazın.
• Bu kısım yapılan değişikliğin ne olduğu, neden yapıldığı ve bu değişikliğin projeye etkisinin ne olduğunu yazdığımız kısımdır.
• Değişikliğin ne olduğunu olabildiğince ayrıntılı şekilde anlatmalıyız.
• Gereksiz ayrıntıdan kaçının.

5. Büyük boyutlu commit mesajlarından kaçının

• 100mb’lik bir mesaj kesinlikle performans sorunlarına neden olacaktır.

6. Mesajları ingilizce yazın

• Ingilizce dünya genelinde ve özellikler teknolji alanında kullanılan ortak dil olduğu için ingilizce kullanmak, projeye katkı sağlayan insanların commit mesajlarını daha kolay okumasına ve anlamasına yardımcı olacaktır.

Bunların yanında footer yani alt bilgide eklenebilir ve bu genelde jira kimlik numarası veya sorunun numarası gibi harici bir referans kimlik numarasıdır.

Kötü commit örneği.


İyi commit örneği.

Bu commit mesajı, değişikliğin ne olduğunu açıkça tanımlamaz ve hangi hataları düzelttiği belirtilmez. Bu tür bir commit mesajı, gelecekte bu değişikliği geri izlemeyi zorlaştırabilir.

Sematic commit​

Sematic commit, commitin amacını ve ne iş yaptığımızı kısa ve oz olarak belirten bir yapıya sahiptir. Commit mesajlarının okunakligini artırır bunun yanında değişikliklerin daha anlaşılır şekilde takip edilmesini sağlar.

Sematic commit, commit mesajının başlığına bir on ek ve ardından kısa açıklama eklenmesiyle oluşur. Bunun yanında hangi bölümde değişiklik yapıldığını parantez içinde belirtebilirsiniz.

Örnek olarak aşağıdaki commite bakalım.

Yukarıdaki committe “feat” eki yeni bir özellik eklendiğini belirtmektedir. “login” ise hangi bölümde ekleme yapıldığını belirtir.

Sematic commitin genel yapısı aşağıdaki gibidir.

• feat: “feature” kelimesinin kısaltmasıdır ve yeni bir özellik eklendiğinde kullanılır.
• fix: Hata düzeltmeleri için kullanılır.
• docs: Dokümantasyon değişiklikleri için kullanılır.
• style: Kodun stilinde yapılan değişikliklerde kullanılır.
• refactor: Var olan kodu iyileştirmek, yeniden yapılandırmak veya düzenlemek için kullanılır.
• test: Testler ile ilgili değişiklikler için kullanılır.
• chore: Kodun bakımı veya yapılandırması ile ilgili değişikliklerde kullanılır.

Daha fazla ayrıntı için bakınız: Semantic Commit Messages

Aşağıda birkaç tane commit örneği bulunmaktadır:

Git ticket sistemine sahip ekipler​

Çoğu ekip, belirli bir iş bölümüne bir bilet numarası atayan “Jira” ve benzeri ticket sistemleri kullanır.

Commit mesajlarını yazarken, proje yönetimi için bir bilet veya takip sistemi kullanıyorsanız, commit mesajlarınızda bilet numaralarını kullanmak yararlı olabilir.

Örnek olarak Jira ticket’i “ACME-1” için aşağıdaki gibi bilet numarasını commitin başına dahil etmek kullanılan bir yöntemdir.


Burada, “ACME-1” bilet numarası, değişikliğin hangi bilet için yapıldığını açıkça belirtir.

Bilet numaralarını commit mesajlarında kullanmak, hem diğer geliştiricilerin değişikliklerin hangi biletlerle ilgili olduğunu anlamalarına yardımcı olur, hem de proje yönetimindeki biletlerin takibini kolaylaştırır. Böylece, bilet numaralarını kullanmak, projenin izlenebilirliğini ve yönetilebilirliğini artırır

Yardımcı kaynaklar:

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

gerçekten emek kokan bir konu olmuş eline sağlık kaynakça için ayrıca teşekkür ederim

MixPro' Alıntı:

gerçekten emek kokan bir konu olmuş eline sağlık kaynakça için ayrıca teşekkür ederim

Genişletmek için tıkla ...

rica ederim