रिलीज़ नोट लिखें

यह दस्तावेज़ Bazel योगदान देने वालों को टारगेट करता है.

Bazel में मौजूद कमिटी की जानकारी में, RELNOTES: टैग के बाद रिलीज़ नोट शामिल होता है. Bazel की टीम हर रिलीज़ में होने वाले बदलावों को ट्रैक करने और रिलीज़ की सूचना लिखने के लिए इसका इस्तेमाल करती है.

खास जानकारी

• क्या आपने जो गड़बड़ी ठीक की है वह बदल गई है? ऐसे में, आपको प्रॉडक्ट की जानकारी नहीं देनी होगी. कृपया GitHub से जुड़ी समस्या के बारे में बताएं.

• अगर इस बदलाव के लागू होने पर, Bazel का इस्तेमाल किया जा सकता है / इसे हटाया जा सकता है / इस वजह से उपयोगकर्ता को जानकारी दिखती है, तो इसे टैग करना फ़ायदेमंद हो सकता है.

अगर बदलाव ज़्यादा बड़ा है, तो पहले डिज़ाइन दस्तावेज़ की नीति का पालन करें.

दिशा-निर्देश

हमारे उपयोगकर्ताओं की ओर से रिलीज़ नोट पढ़े जाएंगे, इसलिए यह छोटा होना चाहिए (बेहतर होगा कि एक वाक्य हो), शब्दावली से बचें (बेजल-आंतरिक शब्दावली), इस पर ध्यान दिया जाना चाहिए कि यह बदलाव किस बारे में है.

• काम के दस्तावेज़ का लिंक शामिल करें. करीब-करीब सभी रिलीज़ नोट में एक लिंक होना चाहिए. अगर ब्यौरे में किसी फ़्लैग, सुविधा, किसी निर्देश का नाम शामिल है, तो उपयोगकर्ता शायद इसके बारे में ज़्यादा जानना चाहेंगे.

• कोड, सिंबल, फ़्लैग या अंडरस्कोर वाले किसी भी शब्द के आस-पास बैककोट का इस्तेमाल करें.

• सिर्फ़ गड़बड़ियों की जानकारी कॉपी करके चिपकाएं. वे अक्सर छिपे हुए होते हैं और सिर्फ़ हमारे लिए उनके काम के होते हैं और उपयोगकर्ता को सिर खुजाने की ज़रूरत होती है. रिलीज़ नोट का मतलब यह बताना है कि क्या बदल गया है और क्यों उपयोगकर्ता को समझने में आसान.

• हमेशा काल का इस्तेमाल करें. साथ ही, "Bazel अब Y के साथ काम करता है" या "X अब Z का इस्तेमाल करता है". हम नहीं चाहते कि हमारे प्रॉडक्ट की जानकारी, गड़बड़ी की जानकारी जैसी दिखे. रिलीज़ नोट में दी गई सभी जानकारी, जानकारी देने वाली होनी चाहिए. साथ ही, उसका टेक्स्ट, स्टाइल, और भाषा के हिसाब से होना चाहिए.

• अगर किसी चीज़ को हटा दिया गया है या निकाल दिया गया है, तो "X को हटा दिया गया है" या "X को हटा दिया गया है" का इस्तेमाल करें. "हटाया गया" या "हटाया गया" नहीं है.

• अगर Bazel अब कुछ अलग तरीके से करता है, तो मौजूदा तनाव की स्थिति में, "$oldव्यवहार" के बजाय "$newव्यवहार" का इस्तेमाल करें. इससे उपयोगकर्ता को यह पता चलता है कि नई रिलीज़ से उनसे क्या उम्मीद की जाती है.

• अगर Bazel अब काम करता है या किसी चीज़ का समर्थन नहीं करता है, तो "Bazel अब समर्थित है / अब X का समर्थन नहीं करता है".

• यह बताएं कि किसी चीज़ को क्यों हटाया गया है / क्यों हटाया गया / बदला गया. एक वाक्य काफ़ी है, लेकिन हम चाहते हैं कि उपयोगकर्ता उसके बिल्ड पर होने वाले असर का आकलन कर सके.

• आगे के फ़ंक्शन के बारे में कोई वादा न करें. "यह फ़्लैग हटा दिया जाएगा" या "इसे बदल दिया जाएगा" से बचें. यह असमंजस की स्थिति पैदा करता है. उपयोगकर्ता को सबसे पहले जब "सबसे ज़्यादा इंतज़ार" करना होगा और हम नहीं चाहते कि उन्हें इस बात की चिंता होने लगे कि उनके मौजूदा बिल्ड अप-टू-डेट हैं.

संसाधित करें

रिलीज़ प्रक्रिया के हिस्से के तौर पर, हम हर काम के RELNOTES टैग इकट्ठा करते हैं. हम हर चीज़ को Google दस्तावेज़ में कॉपी करते हैं, जहां हम नोट की समीक्षा करते हैं, उनमें बदलाव करते हैं, और उन्हें व्यवस्थित करते हैं.

रिलीज़ मैनेजर, bazel-dev की ईमेल पाने वाले लोगों की सूची में ईमेल भेजता है. बैजल योगदान देने वालों को दस्तावेज़ में योगदान देने के लिए न्योता दिया जाता है. साथ ही, यह पक्का करें कि सूचना में किए गए बदलाव सही ढंग से दिखें.

बाद में, bazel-blog के डेटा स्टोर करने की जगह का इस्तेमाल करके, एलान को Bazel ब्लॉग पर सबमिट किया जाएगा.