Başlarken

Taahhüt kuralımızı öğrenin

2 min read
269 words

Projelerimizin temiz bir geçmişe sahip olmasını seviyoruz. Komutlarımıza dair convention'ımız, Conventional Commits'tan ilham alınarak oluşturuldu ama daha görsel ve eğlenceli hale getirmek için gitmoji ile uyumlu bir şekilde düzenlendi.

Yapı

Commit mesajı aşağıdaki gibi yapılandırılmalı ve küçük harfle olmalı:

<gitmoji> <type> <description> [(#<issue number>)]

[isteğe bağlı gövde]

[isteğe bağlı alt bilgiler]

Örnek

📝 belge katkılarını güncelle

- @jerembdn'i katkıcı olarak ekle
- @younesbessa'yı katkıcı olarak ekle

Co-authored-by: Younes Bessa <[email protected]>

Çoğu zaman, basit bir satır yeterli:

📝 belge katkılarını güncelle

Türler

Aşağıdaki commit türlerini kullanıyoruz:

TürAçıklama
addYeni bir özellik ekle
fixBir hatayı düzelt
improveBir şeyi geliştir
updateBir şeyi güncelle
removeBir şeyi kaldır
refactorBir şeyi yeniden yapılandır
renameBir şeyi yeniden adlandır
moveBir dosyayı veya klasörü taşı
upgradeBağımlılıkları güncelle
downgradeBağımlılıkları düşür

Açıklama

Açıklamaları emir kipinde ve küçük harfle yaz:

# İyi
📝 belge katkılarını güncelle

# Kötü
📝 belgeleri güncelledim

# Kötü
📝 Belge katkılarını güncelle

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:

📝 belge katkılarını güncelle

- @jerembdn'i katkıcı olarak ekle
- @younesbessa'yı katkıcı olarak ekle

Co-authored-by: Younes Bessa <[email protected]>

Bir Commit, Bir Amaç

Her commit, tek bir mantıksal değişikliği temsil etmelidir. İlgisiz değişiklikleri karıştırmayın.