सार्वजनिक प्रोजेक्ट और दावा चुनें
अपने प्रोजेक्ट या जिस संगठन की आप जाँच कर रहे हैं, उसके लिए एक विशिष्ट सार्वजनिक रिपॉज़िटरी से शुरू करें। उसका पूरा owner और repository नाम कॉपी करें। जिस सटीक फ़ीचर स्टेटमेंट को आपको खोजना है उसे लिखें, और दस्तावेज़ीकरण को कार्यान्वयन के परीक्षण से अलग रखें।
इस प्रक्रिया का उपयोग प्रोजेक्ट दस्तावेज़ीकरण खोजने के लिए करें। उजागर क्रेडेंशियल, निजी संपर्क जानकारी या रिपॉज़िटरी एक्सेस नियंत्रणों को बायपास करने के तरीकों की खोज न करें।
कोड-सर्च क्वालिफ़ायर का सोच-समझकर उपयोग करें
GitHub का कोड-सर्च दस्तावेज़ बताता है कि एक साधारण शब्द फ़ाइल पाथ या उसकी सामग्री दोनों में से किसी से भी मेल खा सकता है। repo: खोज को पूर्ण owner/repository नाम तक सीमित करता है, path: पाथ को संकीर्ण करता है और content: शब्द को फ़ाइल के मुख्य भाग में होना अनिवार्य करता है। उद्धृत स्ट्रिंग सटीक शब्दावली खोज सकती हैं। ये नियम कोड सर्च पर लागू होते हैं, स्वतः issues या profile search पर नहीं। स्रोत
example-owner/example-project नामक एक उदाहरण रिपॉज़िटरी के लिए, क्वेरी इस प्रकार हो सकती है:
repo:example-owner/example-project content:"export format"नाम और वाक्यांश प्लेसहोल्डर हैं, वह वास्तविक खोज नहीं जो हमने की। जिस रिपॉज़िटरी की समीक्षा करने के लिए आप अधिकृत हैं और आपके प्रश्न से संबंधित शब्दावली को उसमें प्रतिस्थापित करें। यदि आप जानते हैं कि फ़ाइलें किसी दस्तावेज़ीकरण पाथ के अंतर्गत हैं, तो उपयुक्त path: प्रतिबंध जोड़ें; अन्यथा उस धारणा को छोड़ दें।
उद्धृत करने से पहले मिलान की व्याख्या करें
| परिणाम | क्या जाँचें | यह क्या सिद्ध नहीं करता |
|---|---|---|
| मिलता हुआ फ़ाइल नाम | क्या वाक्यांश मुख्य भाग में आता है | फ़ाइल उस कथन का समर्थन करती है |
| दस्तावेज़ीकरण अंश | आस-पास का संस्करण और फ़ीचर योग्यताएँ | वर्णित फ़ीचर का परीक्षण किया गया |
| उदाहरण या प्रस्ताव | क्या यह नियोजित या उदाहरणात्मक व्यवहार का वर्णन करता है | कार्यक्षमता जारी है |
| खाली परिणाम | रिपॉज़िटरी, क्वेरी प्रकार और प्रतिबंध | दावा कहीं भी कभी अस्तित्व में नहीं था |
GitHub सभी सार्वजनिक रिपॉज़िटरी में कोड सर्च के लिए साइन-इन आवश्यकता का दस्तावेज़ीकरण करता है। यह GitHub Pages वेबसाइट को रिपॉज़िटरी स्रोत सामग्री से भी अलग करता है। स्रोत वास्तविक खोज सतह और एक्सेस सीमाओं को रिकॉर्ड करें; साइन-इन प्रतिबंध को बायपास न करें और न ही किसी अनसर्च की गई वेबसाइट को कवर मानें।
अंश को संस्करण से जोड़े रखें
फ़ाइल खोलें और पूरा प्रासंगिक अनुभाग पढ़ें। दस्तावेज़ीकृत दावे को प्रोजेक्ट को श्रेय दें। केवल इस पठन कार्य को पूरा करने के लिए रिपॉज़िटरी कोड न चलाएँ, और स्टार या खाता नामों से उत्पाद की विश्वसनीयता का अनुमान न लगाएँ।
सही अंश मिल जाने के बाद, निरीक्षित संस्करण को बनाए रखने के लिए GitHub permalink गाइड का पालन करें। इसके बाद AI स्रोत-समीक्षा चेकलिस्ट उस दस्तावेज़ के कथन को मॉडल द्वारा जोड़े गए निष्कर्षों से अलग करने में मदद करती है।