Uygun Teslim Mesajlarıyla Github İtibarınızı Artırın

Tek satırlık git commit mesajları yazmak yerine commit -m seçeneği, bu makalede uygun commit mesajlarının nasıl yazılacağını öğrenin. Başkalarının tam olarak neyi değiştirdiğinizi görmesine izin verdiği için uygun bir commit mesajları önemlidir. projenizi başkalarının takip etmesini kolaylaştırmak, açık kaynağa maruz kalmanızı artırmaya yardımcı olmak topluluk.

Uygun Bir Taahhüt Mesajı Yazın

Commit mesajını terminal komutuna eklemek yerine, favori mesajınızı açın Metin düzeltici boş bir dosyaya. Mesaj aşağıdaki biçime uygun olmalıdır:

• İlk satır, işlemin tamamını özetleyen başlıktır.
• Boş bir satırı takiben, sonraki satır veya birkaç satır, kaydetme için gerekli herhangi bir okunabilir açıklama olmalıdır. Bu arzu edildiği kadar uzun olabilir.
  instagram viewer
• Aşağıdaki tüm satırlar, kodda yapılan tam değişiklikleri böyle bir formatta özetlemelidir:
  • Dosya adı: Satır # - Değişikliğin kısa açıklaması.

Örnek Teslim Mesajı

Aşağıda örnek bir commit mesajı gösterilmektedir:

Docker desteği, yeni is_unique özelliği ve hata düzeltmesi eklendi.
Docker-compose için destek eklendi ve gerektiği şekilde güncellenmiş kurulum talimatı. Ayrıca, benzersizliği kontrol etmek için check_order () işlevine yeni bir özellik dahil edildi ve ürün sümüklü böcekleri oluştururken küçük hata düzeltildi.
src / somedir / library.py: 381 - check_order () işlevine 'is_unique' parametresi eklendi.
src / products.py: 194 - Ürün bilgisi oluştururken karşılaşılan hata düzeltildi.
docker-compose.yml - docker-compose dosyası eklendi.
docs / install.md - Docker aracılığıyla nasıl kurulacağını içeren güncellenmiş kurulum kılavuzu.

Kaydetme Mesajı

Şimdi bir taahhütte bulunurken, kullanmak yerine -m mesajını kullanın--dosya seçenek. Örneğin, commit mesajınızın dosya adı commit.txt ise şu komutu çalıştırırsınız:

git commit - dosya commit.txt

Hepsi bu kadar! Umarım bu, takipçilerinize daha standart ve net taahhüt mesajları sunmanıza, projenizin ortaya çıkmasına yardımcı olur ve açık kaynak topluluk büyür.

İmaj Kredisi: Caleb White /Unsplash