उपयोगकर्ता-केंद्रित टेम्पलेट से शुरू करें
वर्ग कोष्ठक वाले हर फ़ील्ड को सत्यापित जानकारी से बदलें। सुविधाएँ गढ़ने के बजाय असंबंधित अनुभाग हटाएँ। अपग्रेड के लिए कोई कार्रवाई आवश्यक न हो तो समर्थित अपग्रेड मार्ग जाँचने के बाद इसे स्पष्ट रूप से बताएँ।
# [संस्करण] — [रिलीज़ की तारीख]
## मुख्य बातें
- [उपयोगकर्ता को दिखने वाला सुधार और उससे लाभ पाने वाले]
## अपग्रेड
- किससे: [समर्थित पिछला संस्करण]
- कार्रवाई: [आवश्यक माइग्रेशन या कोई कार्रवाई आवश्यक नहीं]
- सत्यापन: [सफल अपग्रेड की पुष्टि कैसे करें]
## संगतता तोड़ने वाले बदलाव
- [बदला हुआ व्यवहार, प्रभावित उपयोगकर्ता और माइग्रेशन लिंक]
## सुधार
- [हल की गई समस्या और इश्यू या पुल अनुरोध का लिंक]
## ज्ञात समस्याएँ
- [बाकी सीमा और वैकल्पिक उपाय]
## योगदानकर्ता
[योगदानकर्ताओं को श्रेय दें और पूरे बदलाव लॉग का लिंक दें]जनरेट किए गए नोट्स को पढ़ने योग्य व्याख्या में बदलें
GitHub ऐसे नोट्स बना सकता है जिनमें मर्ज किए गए पुल अनुरोध, योगदानकर्ता और पूरे बदलाव लॉग का लिंक हो। इस आउटपुट को मसौदा मानें। रिलीज़ की सीमा जाँचें, असंबंधित प्रविष्टियाँ हटाएँ और बदलावों को उपयोगकर्ताओं के कार्यों के अनुसार समूहित करें।
उदाहरण के लिए, “पार्सर का एज केस ठीक किया” बहुत कम मार्गदर्शन देता है। अगर सही हो, तो बताएँ कि खाली अंतिम कॉलम वाली CSV फ़ाइलें अब सही इंपोर्ट होती हैं और तकनीकी विवरण के लिए सुधार का लिंक दें। केवल एक मामला बदला हो तो सभी पार्सिंग समस्याएँ हल होने का दावा न करें।
घोषणा से पहले अपग्रेड मार्ग की समीक्षा करें
समर्थित पिछले संस्करण से दस्तावेज़ित अपग्रेड आज़माएँ। डाउनलोड लिंक जाँचें और सुनिश्चित करें कि दस्तावेज़ रिलीज़ से मेल खाते हैं। प्रीव्यू और स्थिर रिलीज़ में अंतर स्पष्ट करें तथा बाकी सीमाएँ आसानी से मिलने दें।
समुदाय की पोस्ट में लिंक देने से पहले रिलीज़ की जानकारी प्रकाशित करें। घोषणा में एक महत्वपूर्ण सुधार उजागर करें, जबकि रिलीज़ नोट्स विस्तृत संदर्भ बने रहें। बाद में आए प्रश्न दर्ज करें और ज़रूरत पर निर्देश स्पष्ट करें।
सामान्य प्रश्न
क्या रिलीज़ नोट्स और बदलाव लॉग एक ही हैं?
इनमें कुछ समानता है। बदलाव लॉग समय के साथ हुए बदलाव दर्ज करता है; रिलीज़ नोट्स किसी खास रिलीज़ और उपयोगकर्ताओं पर उसके प्रभाव को समझाते हैं। दोनों को लिंक करें ताकि पाठक सारांश और विवरण के बीच जा सकें।
क्या अपने-आप बने नोट्स बिना बदलाव के प्रकाशित कर सकता हूँ?
पहले उनकी समीक्षा करें। जनरेट किए गए पुल अनुरोध शीर्षकों में माइग्रेशन के चरण, उपयोगकर्ता पर प्रभाव या ज्ञात समस्याएँ छूट सकती हैं।
क्या हर छोटा कोड बदलाव मुख्य बातों में होना चाहिए?
नहीं। मुख्य बातों में उपयोगकर्ताओं के लिए महत्वपूर्ण बदलाव रखें और विस्तृत तकनीकी इतिहास लिंक किए गए बदलाव लॉग में रहने दें।