Bu doküman, Bazel'deki katkıda bulunanları hedeflemektedir.
Bazel'deki kaydetme açıklamaları arasında RELNOTES: etiketi ve ardından bir sürüm bulunur
not. Bu, Bazel ekibi tarafından her sürümdeki değişiklikleri izlemek ve sürümdeki değişiklikleri izlemek için kullanılır.
yayın duyurusu yapmaktır.
Genel Bakış
Yaptığınız değişiklik bir hata düzeltmesi mi? Bu durumda sürüm notuna ihtiyacınız yoktur. Lütfen GitHub sorununa bir referans ekleyin.
Değişiklik, Bazel'i kullanıcıların görebileceği bir şekilde ekler/kaldırır/değiştiriyorsa bu durumdan bahsetmek yararlı olabilir.
Değişiklik önemliyse tasarım dokümanındaki talimatları uygulayın politikasına öncelik verin.
Yönergeler
Sürüm notları kullanıcılarımız tarafından okunacağı için kısa olmalıdır (ideal olarak bir cümlecik), jargondan (Bazel-iç terminolojisi) kaçının), pek de önemli olmadığını düşünüyorum.
İlgili belgelerin bağlantısını ekleyin. Neredeyse her sürüm notunda bir bağlantı bulunmalıdır. Açıklamada bir işaret, özellik veya komut adı varsa kullanıcılar muhtemelen bu konu hakkında daha fazla bilgi edinmek ister.
Kod, simge, bayraklar veya alt çizgi.
Hata açıklamalarını kopyalayıp yapıştırmakla yetinmeyin. Bu mesajlar genellikle gizemlidir ve yalnızca bize anlamlı gelir. Kullanıcılar ise kafalarını karıştırır. Sürüm notları kullanıcının anlayabileceği bir dille açıklamak anlamına gelir.
Her zaman şimdiki zaman kipini ve "Bazel artık Y'yi destekliyor" veya "X artık Z'yi yapıyor" biçimini kullanın. Sürüm notlarımızın hata girişleri gibi görünmesini istemeyiz. Tüm sürümler girişlerin bilgilendirici olması, tutarlı bir stil ve dil kullanması gerektiğini unutmayın.
Bir özellik kullanımdan kaldırıldıysa veya kaldırıldıysa "X özelliğinin desteği sonlandırıldı" veya "X özelliği kaldırıldı" ifadesini kullanın. "Kaldırıldı" veya "kaldırıldı" değil.
Bazel artık bir şeyi farklı şekilde yapıyorsa şimdiki zamanda "X artık $oldBehavior yerine $newBehavior yapıyor" ifadesini kullanın. Bu, kullanıcının ne yapması gerektiğini beklentilerini netleştirmeye ayırmalısınız.
Bazel artık bir öğeyi destekliyor veya desteklemiyorsa "Bazel artık şunları destekliyor: / artık X'i desteklemiyor".
Bir şeyin neden kaldırıldığını / kullanımdan kaldırıldığını / değiştirildiğini açıklayın. Bir cümle ancak kullanıcıların derlemeleri üzerindeki etkiyi değerlendirebilmesini istiyoruz.
Gelecekteki işlevlerle ilgili hiçbir vaatte BULUNMAYIN. "Bu işaret kaldırıldı" veya "bu değişecek." Belirsizlik oluşturur. Kullanıcının aklına ilk gelen soru "Ne zaman?" olur. Kullanıcıların mevcut derlemelerinin bilinmeyen bir zamanda bozulacağı konusunda endişelenmeye başlamasını istemeyiz.
İşleme
Sürüm oluşturma işleminin bir parçası olarak her bir kayda ait RELNOTES etiketlerini toplarız. Her şeyi bir Google Dokümanı'na kopyalayarak notları inceleriz, düzenleriz ve düzenleriz.
Sürüm yöneticisi, bazel-dev posta listesine bir e-posta gönderir. Bazel katılımcılarını dokümana katkıda bulunmaya davet ediyoruz. değişiklikleri duyuruda doğru şekilde yansıtıldığından emin olun.
Daha sonra duyuru Bazel'e gönderilecektir. blog'u kullanarak bazel-blog depo.