Başlarken
Tavir kurallarımızı öğrenin
Biz temiz bir proje tarihini seviyoruz. Commits geleneklerimiz, Conventional Commits ilham almış ama gitmoji ile özelleştirilmiş, bu da daha görsel ve eğlenceli hale getiriyor.
Yapı
Commit mesajı aşağıdaki gibi yapılandırılmalı ve küçük harfle yazılmalı:
<gitmoji> <type> <description> [(#<issue number>)]
[isteğe bağlı gövde]
[isteğe bağlı footer'lar]
Örnek
📝 belge katkılarını güncelle
- @jerembdn'yi katkıda bulunan olarak ekle
- @younesbessa'yı katkıda bulunan olarak ekle
Ko-yazar: Younes Bessa <[email protected]>
Çoğu zaman, basit bir satır yeterlidir:
📝 belge katkılarını güncelle
Türler
Aşağıdaki commit türlerini kullanıyoruz:
| Tür | Açıklama |
|---|---|
add | Yeni bir özellik ekle |
fix | Bir hatayı düzelt |
improve | Bir şeyi geliştir |
update | Bir şeyi güncelle |
remove | Bir şeyi kaldır |
refactor | Bir şeyi yeniden düzenle |
rename | Bir şeyi yeniden adlandır |
move | Bir dosyayı veya klasörü taşı |
upgrade | Bağımlılıkları yükselt |
downgrade | Bağımlılıkları düşür |
initial | Bir depo için ilk commit |
release | Yayın / sürüm etiketi |
Bir deponun ilk commit'i initial kullanır ve bir sürüm etiketi release kullanır:
🎉 ilk commit
🔖 yayın @onruntime/translations v0.3.0
Açıklama
<type>, konunun fiilidir ve açıklama bunu tamamlar. Birlikte okunduğunda, tek bir cümle oluştururlar:
# İyi
📝 belge katkılarını güncelle
Bu yüzden açıklamayı ikinci bir fiil ile açmayın. Tür zaten bir tanedir ve konu iki cümle birleştirilmiş gibi olur ki bu da fix: ön ekinin sonucudur. Fiili bırakın ve eylemin uygulandığı şeyi koruyun:
# Kötü
💄 kartında mücevheri ölçeklendirin
🐛 altbilgiyi sarmayı durdur
# İyi
💄 kartında mücevherin boyutunu geliştir
🐛 altbilgi sarmasını düzelt
Bunu emredici modda ve küçük harfle yazın:
# Kötü
📝 belge katkılarını güncelledim
# Kötü
📝 Belge katkılarını güncelle
Bir Fiil ki İsimdir
Bazı kelimeler hem fiil hem de isimdir ve kastettiğiniz isimdir: ✨ açık grafik resmi ekle iyidir. Fiil gibi okunursa, bir tanımlık onu tekrar isim ifadesi yapar: ✨ daha fazla göster butonu ekle.
Sorun Numarası
Commit'leri sorunlara bağlamak için sorun numarasını ekleyin:
📝 belge katkılarını güncelle (#123)
Gövde
Gövdeyi bağlam ve motivasyon için kullanın:
📝 belge katkılarını güncelle
- @jerembdn'yi katkıda bulunan olarak ekle
- @younesbessa'yı katkıda bulunan olarak ekle
Ko-yazar: Younes Bessa <[email protected]>
Bir Commit, Bir Amaç
Her commit, tek bir mantıksal değişikliği temsil etmelidir. İlişkisiz değişiklikleri karıştırmayın.