Değişiklik Günlüğü Şablonu

Keep a Changelog kurallarına uyan bir yazılım projesi değişiklik günlüğü şablonu.

# Değişiklik Günlüğü Şablonu: Profesyonel Proje Belgeleri İçin Temel Araç Seti Bir yazılım projesini sürdürmek, sadece kod yazmaktan ibaret değildir; çalışmanızın gelişimini kullanıcılarınıza, katkıda bulunanlara ve gelecekteki kendinize iletmekle ilgilidir. Ancak birçok yazılımcı için, bir CHANGELOG.md dosyasını güncelleme görevi genellikle ikinci plana atılır veya sürüm heyecanı içinde tamamen unutulur. "Changelog Template", bu boşluğu doldurmak için tasarlanmış, endüstri standardı kuralları takip eden yüksek kaliteli değişiklik günlüklerini sürdürmek için akıcı, sezgisel ve profesyonel bir iş akışı sağlayan bir Chrome uzantısıdır. ## Temel Amaç: "Keep a Changelog" Aracılığıyla Daha İyi İletişim Changelog Template, özünde yazılım projelerinin "Keep a Changelog" kurallarına uymasına yardımcı olmak için tasarlanmıştır. İyi bir değişiklik günlüğü, bir projenin her sürümü için önemli değişikliklerin kronolojik olarak sıralanmış, özenle hazırlanmış bir listesidir. Git commit'lerinin ham bir dökümü değil, insanlar için yazılmış bir belgedir. Bu uzantıyı kullanarak, projenizin geçmişinin okunabilir, düzenli ve yararlı olmasını sağlarsınız. İster küçük bir yan proje, ister büyük bir açık kaynak kütüphanesi veya dahili araçlar paketi yönetiyor olun, Changelog Template geliştirme döngünüze ek yük getirmeden şeffaflığı ve profesyonelliği korumanız için gereken yapıyı sunar. ## Güvenebileceğiniz Standart Bir Format Uzantı, standart değişiklik günlüğü formatıyla tam uyumlu çalışır; böylece belgelerinizin profesyonel görünmesini ve daha geniş ekosistemle uyumlu kalmasını sağlar. Oluşturduğunuz her girdi, "Keep a Changelog" projesi tarafından önerilen altı standart değişiklik türünden birine kategorize edilir: 1. **Added (Eklendi):** Yazılımınızın yeteneklerini genişleten yeni özellikler için. 2. **Changed (Değiştirildi):** İşleyişi değiştiren mevcut fonksiyonlardaki değişiklikler için. 3. **Deprecated (Kullanımdan Kaldırılıyor):** Yakında kaldırılacak özellikler için, kullanıcılara geçiş yapmaları adına önceden uyarı sağlar. 4. **Removed (Kaldırıldı):** Kod tabanından resmi olarak çıkarılan özellikler için. 5. **Fixed (Düzeltildi):** Sorunları çözen ve kararlılığı artıran hata düzeltmeleri için. 6. **Security (Güvenlik):** Güvenlik açıklarını gideren kritik yamalar için. Bu kategorizasyon, kullanıcılarınızın yeni araçlar ararken veya belirli bir hatanın giderilip giderilmediğini kontrol ederken sürüm notlarınızı hızla taramalarına yardımcı olur. ## Etkili Girdiler Yazmak İçin Rehberlik İyi bir değişiklik günlüğü girdisi yazmak bir sanat formudur. Teknik doğruluk ile erişilebilirlik arasında denge kurmayı gerektirir. Changelog Template size sadece bir metin kutusu sunmaz; önemli girdiler yazmak için gereken bağlamı ve rehberliği sağlar. Üç basit kuralı savunuyoruz: - **Tek Cümle Kullanın:** Kısa ve öz tutun. Girdi başına net bir nokta, yoğun bir paragraftan daha iyidir. - **Geçmiş Zaman Kullanın:** *Neyin değiştiğini* tanımlıyorsunuz (örneğin: "Arama performansı iyileştirildi" yerine "Arama performansını iyileştir