इस दस्तावेज़ में, Android Studio के लिए रिलीज़ नोट बनाने के बारे में निर्देश दिए गए हैं.
मकसद
GitHub repo से कमिट के लिए, रिलीज़ नोट की ज़्यादा जानकारी देने वाला वर्शन बनाने के लिए.
निर्देश
इन निर्देशों का क्रम से और पूरी तरह पालन करें.
पहला चरण: रेपो को क्लोन करना या अपडेट करना
इस प्रोजेक्ट में studio-main फ़ोल्डर देखें. अगर ऐसा नहीं है, तो studio-main रिपॉज़िटरी को क्लोन करें. इसके लिए, यह कमांड इस्तेमाल करें:
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
अगर डायरेक्ट्री पहले से मौजूद है, तो GitHub से रेपो का कॉन्टेंट पुल करके डायरेक्ट्री को रीफ़्रेश करें.
आगे बढ़ने से पहले, मुझे studio-main के स्टेटस के बारे में बताएं.
दूसरा चरण: रिपो के बारे में जानकारी पाना
रिपो के कॉन्टेंट की जांच करें.
तीसरा चरण: कमिट पाना
मुझे उस समयावधि के दौरान studio-main रिपॉज़िटरी में सबमिट किए गए सभी कमिट दिखाओ. आगे बढ़ने से पहले, मुझे संख्या बताएं. गिनती करने के लिए, हमेशा wc -l का इस्तेमाल करें.
टारगेट कमिट की पहचान करें: git लॉग से, हर उस कमिट के लिए पूरा कमिट ब्लॉक निकालें जिसमें "Relnote:
" स्ट्रिंग मौजूद हो. यहां वह प्रॉडक्ट का नाम है जो मैंने दिया है. अगर मैंने किसी प्रॉडक्ट का नाम नहीं दिया है, तो सिर्फ़ "Relnote" खोजें. "कमिट ब्लॉक" में कमिट हैश, लेखक, तारीख, पूरा कमिट मैसेज, और कोड में अंतर शामिल होता है.
सही टूल का इस्तेमाल करें: तारीख की सीमा और प्रॉडक्ट के नाम के हिसाब से कमिट फ़िल्टर करने के लिए, इस कमांड का इस्तेमाल करें:
git log --after="
" --before=" " --grep="Relnote: " यहां
और तारीख की वह सीमा है जो मैंने आपको दी है. साथ ही, वह प्रॉडक्ट का नाम है जो मैंने आपको दिया है. अगर प्रॉडक्ट का नाम नहीं दिया गया है, तो सिर्फ़ इस कमांड का इस्तेमाल करें:
git log --after="
" --before=" " --grep="Relnote" गिनती की पुष्टि करें: मुझे उन सभी कमिट की कुल संख्या, हैश, और टाइटल दिखाएं जिनकी आपने पहचान की है. हम आपको आगे बढ़ने की पुष्टि करेंगे.
चौथा चरण: रिलीज़ के बारे में ज़्यादा जानकारी देने वाले नोट जनरेट करना
हर कमिट का विश्लेषण करें: पिछले चरण में आपने जिन कमिट का पता लगाया है उनमें से हर एक का बारीकी से विश्लेषण करें. इसमें ये शामिल हैं:
- कमिट मैसेज को पूरा पढ़ना.
- बदलाव को समझने के लिए, कोड में अंतर (git show
) की जांच करना. - ज़्यादा जानकारी पाने के लिए, लिंक किए गए किसी भी बग (उदाहरण के लिए, बग: 12345678) को फ़ॉलो करें.
आगे बढ़ने से पहले, मुझसे पुष्टि कर लें.
कमिट से जुड़ी जानकारी के लिए, docs फ़ोल्डर में मौजूद मिलते-जुलते दस्तावेज़ों का विश्लेषण करें. इस जानकारी का इस्तेमाल करके, रिलीज़ नोट में ज़्यादा से ज़्यादा जानकारी शामिल करें.
आगे बढ़ने से पहले, मुझे यह बताओ कि docs फ़ोल्डर में किन कमिट से जुड़ी जानकारी है.
कमिट में मौजूद किसी भी गड़बड़ी के बारे में जानकारी पाएं. कमिट के लिए रिलीज़ नोट बनाने में मदद पाने के लिए, गड़बड़ी की जानकारी का इस्तेमाल करें.
रिलीज़ नोट लिखें: हर कमिट के लिए, एक रिलीज़ नोट लिखें. इसमें यह जानकारी शामिल होनी चाहिए:
कमिट रेफ़रंस: हर रिलीज़ नोट से पहले, सोर्स कमिट हैश वाली Markdown टिप्पणी जोड़ें. जैसे: .
साफ़ तौर पर बताया गया टाइटल: बदलाव के बारे में कम शब्दों में जानकारी देने वाला टाइटल.
पूरी जानकारी: एक पैराग्राफ़ में बताया गया है कि बदलाव किस बारे में है.
बदलाव के बारे में खास जानकारी, इस क्रम में दी गई है:
a. क्यों: क्या बदला और क्यों बदला b. असर: ऐप्लिकेशन डेवलपर पर असर c. माइग्रेशन: माइग्रेशन का तरीका (अगर कोई हो)
"पहले" और "बाद में" कोड के उदाहरण: अगर कमिट में उपयोगकर्ता के लिए कोड में बदलाव किया गया है (उदाहरण के लिए, .gradle फ़ाइलों में डीएसएल में बदलाव या एपीआई में बदलाव), तो बदलाव दिखाने वाले कोड के स्निपेट साफ़ तौर पर और कम शब्दों में दें.
https://developer.android.com/studio/releases पर दिए गए रिलीज़ नोट के स्टाइल गाइड का पालन करें.
पांचवां चरण: रिलीज़ नोट को Markdown फ़ाइल में लिखना
- प्रोजेक्ट के रूट में release-notes-YYYY-MM-DDTHH:MM.md नाम की एक Markdown फ़ाइल बनाएं. इसमें--आईएसओ 8601 फ़ॉर्मैट में--YYYY-MM-DD (साल-महीना-दिन) मौजूदा तारीख है, T एक सेपरेटर है, और HH:MM (24 घंटे के क्लॉक टाइम में घंटे:मिनट) मौजूदा समय है.
- रिलीज़ की जानकारी के बारे में एक ऐसा ब्यौरा लिखें जिसमें यह बताया गया हो कि रिलीज़ की जानकारी क्यों दी जा रही है.
- रिलीज़ की जानकारी का सारांश लिखो.
- फ़ॉर्मैट किए गए रिलीज़ नोट लिखें.
छठा चरण: कमिट बनाना
रिलीज़ नोट फ़ाइल के लिए, Fig कमिट बनाएं. गड़बड़ी का आईडी शामिल न करें.
सातवां चरण: बदलावों की सूची बनाना
कमिट का सीएल बनाएं.