सभी उपयोग के उदाहरण

ग्राहक-फ़ेसिंग रिलीज़ नोट्स जनरेट करें

Zero commits और मर्ज किए गए PR पढ़ता है, बदलावों को ग्राहक प्रभाव के अनुसार क्लस्टर करता है, और पब्लिश के लिए तैयार स्पष्ट, विशिष्ट रिलीज़ नोट्स ड्राफ़्ट करता है।

Zero जुड़ता है:GitHubSlack

Zero क्या डिलीवर करता है

समस्या क्या है

रिलीज़ नोट्स हमेशा लिखे जाने वाली आखिरी चीज़ होती है और रिलीज़ में देरी होने पर कटने वाली पहली चीज़। समस्या सोर्स मटेरियल है: इंजीनियरों के लिए लिखे गए commit messages, ऐसे PR titles जो tribal knowledge मानते हैं, और 30 मर्ज किए गए PR जिनकी आपके यूज़र ज़्यादातर व्यक्तिगत रूप से परवाह नहीं करते। Release Notes Generator वर्कफ़्लो को पलट देता है। Zero commits और PR विवरण पढ़ता है, ग्राहक-दृश्य बदलावों के लिए फ़िल्टर करता है, उन्हें थीम (नए फ़ीचर, सुधार, फ़िक्स) के अनुसार समूहित करता है, और उस आवाज़ में नोट्स लिखता है जिसे आपके ग्राहक वास्तव में पढ़ते हैं। आप रिव्यू करते हैं, और अगली रिलीज़ चुप्पी के बजाय नोट्स के साथ शिप होती है।

Zero इसे कैसे ठीक करता है

चरण 1: अपने tools कनेक्ट करें

GitHub
GitHub
ज़रूरी
GitHub। Zero मर्ज किए गए PR, commit messages, लेबल, और release tags पढ़ता है। repo तक रीड एक्सेस ज़रूरी।
जोड़ें
Slack
Slack
ज़रूरी
Slack। Zero रिव्यू चैनल को ड्राफ़्ट पहुँचाता है और अप्रूव होने पर अंतिम नोट्स पोस्ट करता है। चैनल राइट एक्सेस ज़रूरी।
जोड़ें

चरण 2: Zero से पूछें

@Zero आज हम जो रिलीज़ शिप कर रहे हैं, उसके लिए पिछले release tag के बाद के सभी मर्ज किए गए PR पढ़ो। ग्राहक प्रभाव के अनुसार समूहित करो: नए फ़ीचर, सुधार, बग फ़िक्स। आंतरिक refactors और टेस्ट बदलाव छोड़ दो। हमारी प्रोडक्ट आवाज़ में ग्राहक-फ़ेसिंग नोट्स ड्राफ़्ट करो।
Zero रिलीज़ विंडो में हर मर्ज किए गए PR को पढ़ता है
Zero पिछले release tag के बाद के मर्ज किए गए PR खींचता है, जिसमें titles, विवरण और लेबल शामिल हैं। आंतरिक-केवल बदलाव (refactors, tests, CI tweaks) आपके लेबल कन्वेंशन के आधार पर फ़िल्टर हो जाते हैं।
Zero बदलावों को ग्राहक प्रभाव के अनुसार समूहित करता है
Zero बचे हुए PR को थीम में क्लस्टर करता है: नए फ़ीचर, सुधार, और फ़िक्स। हर बदलाव को PR विवरण से एक ग्राहक-फ़ेसिंग लाइन में फिर से लिखा जाता है: उपयोगी होने के लिए पर्याप्त विशिष्ट, आंतरिक jargon से मुक्त।
Zero आपकी प्रोडक्ट आवाज़ में नोट्स ड्राफ़्ट करता है
अंतिम ड्राफ़्ट आपके docs टूल या Slack में ऐसे सेक्शन के साथ आता है जो आपके रिलीज़-नोट्स टेम्पलेट का पालन करते हैं। आप आवाज़ और बारीकी के लिए एडिट करते हैं, फिर पब्लिश करते हैं।

चरण 3: इसे और आगे ले जाएँ

आवाज़ को परिष्कृत करें
टोन और फ़ॉर्मेटिंग के लिए Zero द्वारा उपयोग की जाने वाली गाइडेंस अपडेट करें।
@Zero अब से, रिलीज़ नोट्स में Markdown हेडर छोड़ दो। केवल सादा गद्य।
पब्लिशिंग के साथ चेन करें
अप्रूव किए गए नोट्स सीधे अपने docs या ब्लॉग पर पुश करें।
@Zero एक बार जब मैं नोट्स अप्रूव कर दूँ, तो उन्हें हमारे docs के Releases सेक्शन में पब्लिश करो और लिंक #announcements में पोस्ट करो।
अनुवाद करें
अपने द्वारा समर्थित हर locale में नोट्स जनरेट करें।
@Zero अप्रूव किए गए रिलीज़ नोट्स का German, Japanese, और Spanish में अनुवाद करो। सेक्शन संरचना संरक्षित रखो।

बेहतर परिणामों के लिए सुझाव

आंतरिक-केवल PR को एक सुसंगत लेबल (जैसे `internal` या `no-release-notes`) से टैग करें। Zero केवल वही छोड़ सकता है जो आप मार्क करते हैं।
अपने docs में रिलीज़ नोट्स के लिए एक छोटी स्टाइल गाइड रखें। ग्राहक आवाज़, सक्रिय क्रियाएँ, कोई आंतरिक jargon नहीं। Zero इसे उठाता है और हर रिलीज़ में लागू करता है।
रिलीज़ शिप होने के बाद नहीं, पहले नोट्स ड्राफ़्ट करें। काम ताज़ा रहते हुए एक ड्राफ़्ट रिव्यू करना एक हफ़्ते बाद संदर्भ पुनर्निर्माण करने से तेज़ है।