Kullanıcı odaklı bir şablonla başlayın
Köşeli parantez içindeki her alanı doğrulanmış bilgilerle değiştirin. Özellik uydurmak yerine ilgisiz bölümleri kaldırın. Yükseltme için işlem gerekmiyorsa desteklenen yükseltme yolunu kontrol ettikten sonra bunu açıkça belirtin.
# [Sürüm] — [Yayımlanma tarihi]
## Öne çıkanlar
- [Kullanıcının gördüğü iyileştirme ve kimlerin yararlandığı]
## Yükseltme
- Başlangıç: [desteklenen önceki sürüm]
- İşlem: [gerekli geçiş veya işlem gerekmiyor]
- Doğrulama: [başarılı yükseltmenin nasıl doğrulanacağı]
## Uyumluluğu bozan değişiklikler
- [Değişen davranış, etkilenen kullanıcılar ve geçiş bağlantısı]
## Düzeltmeler
- [Çözülen sorun ve sorun kaydı veya çekme isteği bağlantısı]
## Bilinen sorunlar
- [Kalan sınırlama ve geçici çözüm]
## Katkıda bulunanlar
[Katkıda bulunanlara teşekkür edin ve tam değişiklik günlüğünü bağlayın]Oluşturulan notları okunaklı bir açıklamaya dönüştürün
GitHub; birleştirilen çekme istekleri, katkıda bulunanlar ve tam değişiklik günlüğü bağlantısını içeren notlar oluşturabilir. Bu çıktıyı taslak olarak değerlendirin. Sürümün kapsam sınırlarını kontrol edin, ilgisiz kayıtları kaldırın ve değişiklikleri kullanıcıların yaptığı görevlere göre gruplandırın.
Örneğin “Ayrıştırıcı uç durumu düzeltildi” ifadesi fazla yol göstermez. Doğruysa son sütunu boş olan CSV dosyalarının artık düzgün içe aktarıldığını açıklayın ve teknik ayrıntılar için düzeltmeye bağlantı verin. Yalnızca bir durum değiştiğinde tüm ayrıştırma sorunlarının çözüldüğünü iddia etmeyin.
Duyurmadan önce yükseltme yolunu inceleyin
Desteklenen bir önceki sürümden belgelenmiş yükseltmeyi deneyin. İndirme bağlantılarını kontrol edin ve belgelerin sürümle eşleştiğinden emin olun. Önizleme sürümünü kararlı sürümden ayırın ve kalan sınırlamaların kolayca bulunmasını sağlayın.
Topluluk gönderisinden bağlantı vermeden önce sürüm bilgilerini yayımlayın. Duyuruda anlamlı bir iyileştirmeyi öne çıkarın; sürüm notları ise ayrıntılı başvuru kaynağı olarak kalsın. Sonraki soruları kaydedin ve gerektiğinde talimatları netleştirin.
Sık sorulan sorular
Sürüm notları ile değişiklik günlüğü aynı mı?
Örtüşürler. Değişiklik günlüğü zaman içindeki değişiklikleri kaydeder; sürüm notları belirli bir sürümü ve kullanıcılar üzerindeki etkisini açıklar. Okuyucuların genel bakış ile ayrıntılar arasında geçebilmesi için bunları birbirine bağlayın.
Otomatik oluşturulan notları değiştirmeden yayımlayabilir miyim?
Önce inceleyin. Oluşturulan çekme isteği başlıklarında geçiş adımları, kullanıcı etkisi veya bilinen sorunlar eksik olabilir.
Her küçük kod değişikliği öne çıkanlarda yer almalı mı?
Hayır. Öne çıkanları kullanıcılar açısından önemli değişiklikler için kullanın ve ayrıntılı teknik geçmişi bağlantı verilen değişiklik günlüğünde tutun.