Bu doküman, Bazel'e katkıda bulunanları hedeflemektedir.
Bazel'deki commit açıklamaları, RELNOTES: etiketi ve ardından bir sürüm notu içerir. Bu, Bazel ekibi tarafından her sürümdeki değişiklikleri izlemek ve sürüm duyurusunu yazmak için kullanılır.
Genel Bakış
Değişiklikleriniz hata düzeltme mi? Bu durumda, sürüm notuna ihtiyacınız yoktur. Lütfen GitHub sorununa 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 önce tasarım dokümanı politikasını uygulayın.
Yönergeler
Sürüm notları kullanıcılarımız tarafından okunacağından kısa (ideal olarak bir cümle) olmalı, jargon (Bazel'e özgü terminoloji) kullanılmamalı ve değişikliğin neyle ilgili olduğuna odaklanmalıdır.
İ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, işaret veya alt çizgi içeren kelimelerin etrafında ters tırnak işareti kullanın.
Hata açıklamalarını kopyalayıp yapıştırmayın. Bu mesajlar genellikle gizemlidir ve yalnızca bize anlamlı gelir. Kullanıcılar ise kafasını karıştırır. Sürüm notları, kullanıcıların anlayabileceği bir dille nelerin değiştiğini ve neden değiştiğini açıklamak için hazırlanır.
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üm notu girişleri bilgilendirici olmalı ve tutarlı bir üslup ve dil kullanılmalıdır.
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 sayede kullanıcı, yeni sürümü kullanırken nelerle karşılaşacağını ayrıntılı olarak öğrenebilir.
Bazel artık bir özelliği destekliyorsa veya desteklemiyorsa "Bazel artık X özelliğini destekliyor/desteklemiyor" ifadesini kullanın.
Bir öğenin neden kaldırıldığını / desteği sonlandırıldığını / değiştirildiğini açıklayın. Bir cümle yeterlidir ancak kullanıcının derlemelerinin üzerindeki etkiyi değerlendirebilmesini isteriz.
Gelecekteki işlevler hakkında HİÇBİR söz vermeyin. "Bu işaret kaldırılacak" veya "Bu değiştirilecek" gibi ifadelerden kaçının. 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. Bazı katkıda bulunanlar, dokümana katkıda bulunmaya ve değişikliklerinin duyuruya doğru şekilde yansıtıldığından emin olmaya davet edilir.
Daha sonra duyuru, bazel-blog deposu kullanılarak Bazel bloguna gönderilir.