उस अंश को चुनें जिसे आपको समर्थन देना है
मान लीजिए कि आप किसी लेख में उल्लेख करने से पहले अपने ही प्रोजेक्ट के सार्वजनिक README में एक इंस्टॉलेशन कथन की जाँच कर रहे हैं। सटीक अंश और उसके आस-पास की शर्तें खोजें। रिपॉज़िटरी का शीर्षक या प्रोफ़ाइल जीवनी उस फ़ाइल का विकल्प नहीं है जिसमें कथन मौजूद है।
कार्य को दस्तावेज़ तक सीमित रखें। आपको प्रोजेक्ट चलाने, व्यक्तिगत संपर्क जानकारी की जाँच करने या किसी योगदानकर्ता के खाते को निजी पहचान के प्रमाण के रूप में मानने की आवश्यकता नहीं है।
बदलती शाखा दृश्य को संस्करण लिंक से बदलें
GitHub बताता है कि सामान्य फ़ाइल दृश्य आमतौर पर किसी शाखा के वर्तमान शीर्ष को दिखाता है, इसलिए कमिट आने पर उसकी सामग्री बदल सकती है। फ़ाइल देखते समय y दबाने से URL एक परमालिंक में बदल जाता है जो शाखा नाम के बजाय एक विशिष्ट कमिट का उपयोग करता है। स्रोत
उस क्रिया के बाद वास्तव में दिखाए गए URL को कॉपी करें। उसे फिर से खोलें और पुष्टि करें कि यह वही फ़ाइल और अंश दिखाता है। कमिट पहचानकर्ता का आविष्कार न करें या किसी ऐसे खोज पूर्वावलोकन से उद्धरण न बनाएं जिसे आपने खोला नहीं है।
यदि आप वर्तमान शाखा पता भी चाहते हैं तो अलग नोट रखें। संस्करण लिंक इस प्रश्न का उत्तर देता है कि “मैंने कौन-सा शब्दांकन देखा?” जबकि शाखा दृश्य आपको यह जाँचने देता है कि प्रोजेक्ट अभी क्या प्रस्तुत करता है।
किसी अन्य पाठक के लिए पर्याप्त संदर्भ दर्ज करें
| फ़ील्ड | अपनी जाँच से दर्ज करें | उद्देश्य |
|---|---|---|
| रिपॉज़िटरी और फ़ाइल | वास्तविक प्रोजेक्ट और फ़ाइल पथ | उद्धृत किए जा रहे दस्तावेज़ की पहचान करें |
| कमिट पहचानकर्ता | कॉपी किए गए परमालिंक में मौजूद संस्करण | इस स्नैपशॉट को बाद के संपादनों से अलग करें |
| सहायक अंश | एक संक्षिप्त उद्धरण या निष्ठापूर्ण सारांश | दावे को जाँचे गए शब्दांकन तक सीमित रखें |
| आस-पास की शर्तें | संस्करण, वातावरण या सुविधा सीमाएँ | किसी योग्यता को छोड़ने से बचें |
| पहुँच तिथि | जब आपने स्रोत खोला | अपनी समीक्षा के समय को प्रकाशन इतिहास से अलग रखें |
एक उदाहरण README के लिए जो कहता है कि एक्सपोर्ट सुविधा प्रयोगात्मक है, समर्थित कथन “प्रयोगात्मक” को बनाए रखता है। एक स्थिर URL इसे परीक्षित गारंटी के रूप में फिर से लिखने का औचित्य नहीं देता। यह उदाहरण उद्धरण अभ्यास को दर्शाता है; यह किसी वास्तविक रिपॉज़िटरी के बारे में रिपोर्ट नहीं है।
तय करें कि पुराना कथन अभी भी प्रासंगिक है या नहीं
यदि वर्तमान शाखा भिन्न है, तो दोनों अवलोकन बनाए रखें: वह पुराना संस्करण जिसे आपने उद्धृत किया और वह वर्तमान शब्दांकन जिसे आपने वास्तव में खोला। पुराने उद्धरण को चुपचाप बदलें नहीं और उसे उसी समीक्षा के रूप में वर्णित करना जारी न रखें।
किसी फ़ाइल में योजनाएँ, उदाहरण या पुराने निर्देश हो सकते हैं। उन कथनों को प्रोजेक्ट को आरोपित करें, बजाय यह दावा करने के कि आपने कार्यान्वयन का स्वतंत्र रूप से परीक्षण किया। यदि बाद में पहुँच विफल हो जाती है, तो उस सीमा को दर्ज करें; संस्करण पहचानकर्ता स्थायी होस्टिंग या अनुमति का वादा नहीं है।
यह हस्ताक्षरित-कमिट बैज से भी अलग है। GitHub Verified-बैज गाइड उस भिन्न संकेत को संबोधित करता है। सार्वजनिक दस्तावेज़ों के व्यापक संश्लेषण के लिए, AI स्रोत-समीक्षा चेकलिस्ट का उपयोग करें और प्रत्येक महत्वपूर्ण दावे के आधार पर सटीक संस्करण बनाए रखें।