Git Server kullanırken, profesyonellik gerektiren konulardan bir tanesi Commit mesajları veya commit açıklamalarıdır. Neden mi? Çünkü bir gün sonra, bir hafta sonra, bir ay sonra, bir yıl sonra hatta 5 yıl sonra projede ne iş yaptığınızı, projenizde hangi değişiklikleri yaptığınızı, ne zaman yaptığınızı ve kodun hangi kısımlarında değişiklik yaptığınızı anlamanız bu mesajların içeriğine bağlıdır.Commit Mesajları Projenizdeki Değişiklikleri Takip Edebilmek İçin Yazılır
Öncellikle commit mesajlarının neden yazıldığını çok iyi anlamak lazım. Commit mesajları projenizle ilgili açıklamalar için ve ya projenizi anlatmak, proje boyutunu veya bütçesini açıklamak için değildir. Commit Mesajları projenizde yaptığınız değişikliklerle ilgili yazdığınız açıklamalardır.
Commit Mesajlarının Yazılması
Commit mesajını commit komutunu uygularken ekleriz. Örnek kullanımı aşağıdaki gibidir. Eğer Commit Mesajınız 1 kelimeden daha fazla ise(ki öyle olacaktır) mesajlarınızı çift tırnak(“Mesajınız burada”) içinde olmalıdır.
Git commit –m “Proje Kurulumu”
Commit Mesajları Önemlidir!!!
Projede değişiklikler yaptıkça commit sayıları artmaya başlar. Geriye dönüp baktığınızda, yaptığınız değişikler konusunda sizi yönlendirecek kelimelerin veya cümlelerin secimi önem kazanır.Yazdığınız Commit Mesajı yaptığınız değişiklikler ile ilgili sizi bilgilendirmelidir. Aynı zamanda bir projede çok kişinin çalışabileceği öngörülerek herkes için açıklayıcı olabilecek ifadeler kullanılmalıdır. Bu yüzden bu konuyu önemseyip bunun üzerine makale yazmak istedim.
Commit Karakter Uzunluğu 50 Karakteri Geçmemelidir!!!
Commit karakter uzunluğu çok önemlidir. Neden mi çünkü çok uzun yazılar yazmak hem yazarken hem de okurken zaman kaybı yaşamanıza neden olacaktır. Tabi ki yaptığınız değişiklikler çoksa, yazdığınız mesaj da, yaptığınız değişikliklere bağlı olarak açıklayıcı olması açısından uzun olabilir. Buna rağmen yazdığınız mesajın 50 karakterden uzun olmamasına özen gösterin. Bun rağmen çok kısa açıklamalar da olabilir ama açıklamanızın yaptığınız değişiklerle ilgili açıklaması gerekiyor.
Cümlelerde Şimdiki Zamanı veya Geniş Zamanı Kullanın!!!
Commit mesajları yazarken dikkat etmeniz gereken huşulardan bir tanesi de cümlelerin hangi zamanda kullanılacağı. Birçok profesyonel yazılımcı ve bu konuda eğitim veren kişiler tarafından önerilen yöntem geçmiş zaman yerine, şimdiki zamanda kullanılması. Neden mi? Çünkü daha önce yazılan commit mesajlarını okurken, sizi değişiklikleri yaptığınız ana, zamana götürecektir. Bunu test edebilirsiniz… Bu konuya örnek verecek olursak “Ana sayfa içinde menü açılımındaki Hata Giderildi” mesajı yerine “Ana sayfa içinde menü açılımındaki hataların giderilmesi” gibi bir ifade kullanabilirsiniz. Ayrıca yaptığınız değişiklikler ile ilgili kişi zamirleri de kullanmak doğru yöntem olarak kabul edilmez. “Ben ana sayfa içindeki menü açılımındaki hataları giderdim” gibi bir ifade yerine yukarda olan “Ana sayfa içinde menü açılımındaki hataların giderilmesi” en ideal commit mesajları için idealdir.
Kendi Mesaj Yapınızı Oluşturabilirsiniz
Önerilen bir yöntem de, yaptığınız değişikliklerle ilgili organizasyonel bir yapı oluşturmak. Örneğin değişiklik yaptığınız dosya ismi, yaptığınız değişikliği, değişiklik türü şeklinde bir yapı tercih edebilirsiniz. Aşağıdaki örnekte olduğu gibi
-[pages/contact.html]
-[değişiklik]
-[İletişim numaralarının güncellenmesi]
Bu konuda çok yorum yapmayacağım. Kendi organizasyon yapınıza göre siz kendi yapınızı oluşturabilirsiniz demenin yeterli olduğunu düşünüyorum.
Son olarak şunu belirtmek istiyorum ki, değişikliklerle ilgili yazılan mesajlar önemlidir. Yukarıda yazılanlar dışında kendi mesaj organizasyonunuzu yapıyorsanız, tüm proje ekibince bu yapıya uyulmasına dikkat etmelisiniz. Mesajlarınız yapılan değişiklikle ilgili açıklayıcı olmalı ve söz kalabalığında uzak durmalısınız…
Bu konuda sorularınız varsa lütfen sormaktan çekinmeyin. En kısa sürede yanıtlamaya çalışacağım…
Kolay Gelsin…
Yorumlar
Yorum Gönder