प्रोजेक्ट गाइड

ओपन सोर्स प्रोजेक्ट के लिए GitHub README टेम्पलेट

उपयोगी GitHub README जल्दी चार प्रश्नों के उत्तर देता है: प्रोजेक्ट क्या करता है, किसके लिए है, इसे कैसे आज़माएँ और सहायता कहाँ मिलेगी? नीचे के Markdown टेम्पलेट से शुरुआत करें, फिर हर प्लेसहोल्डर को अपने प्रोजेक्ट के लिए जाँची गई जानकारी से बदलें।

GitHubStart संपादकीय टीम · अपडेट किया गया

यह Markdown README टेम्पलेट कॉपी करें

यह तैयार किया गया शुरुआती टेम्पलेट है, काम करने वाला सॉफ़्टवेयर उदाहरण नहीं। वर्ग कोष्ठकों वाला पाठ बदलें, सुनिश्चित करें कि संदर्भित फ़ाइलें मौजूद हैं और लागू न होने वाले भाग हटाएँ। नीचे इंस्टॉल और रन वाली पंक्तियाँ टिप्पणियाँ हैं ताकि प्लेसहोल्डर कमांड गलती से चल न सकें।

# [प्रोजेक्ट का नाम]

[एक वाक्य: समस्या, लक्षित उपयोगकर्ता और परिणाम।]

## उदाहरण
[एक छोटा इनपुट और उसका अपेक्षित आउटपुट दिखाएँ, या स्क्रीनशॉट जोड़ें।]

## क्विक स्टार्ट
आवश्यकताएँ: [रनटाइम/संस्करण और आवश्यक सेवाएँ]।

```sh
# अपने सत्यापित इंस्टॉलेशन कमांड से बदलें।
# उपयोगी परिणाम देने वाले सबसे छोटे कमांड से बदलें।
```

अपेक्षित परिणाम: [पाठक को क्या दिखना चाहिए]।

## कॉन्फ़िगरेशन
[आवश्यक सेटिंग, सुरक्षित उदाहरण मान और गोपनीय जानकारी रखने की जगह।]

## इसका उपयोग कब करें
- [उपयोग का एक ठोस मामला]
- [उपयोग का दूसरा मामला]

## सीमाएँ
[असमर्थित इनपुट, परिपक्वता, प्रदर्शन या प्लेटफ़ॉर्म की सीमाएँ।]

## दस्तावेज़ और सहायता
[दस्तावेज़ का लिंक दें और बताएँ कि प्रश्न कहाँ पूछें।]

## योगदान
[CONTRIBUTING.md](CONTRIBUTING.md) देखें।
रिपॉज़िटरी के Issues टैब में दोहराई जा सकने वाली समस्या रिपोर्ट करें।

## लाइसेंस
[LICENSE](LICENSE) देखें।

रिपॉज़िटरी के प्रकार के अनुसार उदाहरण बदलें

कमांड-लाइन टूल के लिए इनपुट फ़ाइल, कमांड और छोटा आउटपुट दिखाएँ। लाइब्रेरी के लिए इंपोर्ट और कॉल का सबसे छोटा पूरा उदाहरण दें, जिसमें अपेक्षित रिटर्न मान भी हो। वेब ऐप के लिए मुख्य कार्यप्रवाह दिखाएँ और बताएँ कि होस्ट किया गया डेमो या स्थानीय सेटअप उपलब्ध है या नहीं।

API समझाने के लिए केवल स्क्रीनशॉट पर निर्भर न रहें: पाठक को कोड कॉपी कर पाना चाहिए। दूसरी ओर, दृश्य ऐप को ऐसे स्क्रीनशॉट से लाभ हो सकता है जो स्पष्ट बताए कि उपयोगकर्ता क्या कर रहा है। उस संस्करण से वास्तविक उदाहरण लें जिसे आप अभी वितरित कर रहे हैं।

  • लाइब्रेरी: इंस्टॉलेशन, समर्थित रनटाइम और एक पूरा फ़ंक्शन कॉल।
  • CLI: इनपुट, कमांड, आउटपुट और त्रुटि रिपोर्ट होने का तरीका।
  • वेब ऐप: डेमो लिंक या स्थानीय सेटअप, कॉन्फ़िगरेशन और मुख्य काम का स्क्रीनशॉट।
  • डेटासेट: स्रोत, फ़ॉर्मैट, लाइसेंस और एक छोटा नमूना रिकॉर्ड।

साझा करने से पहले README जाँचें

क्विक स्टार्ट को पहले से विकास के लिए तैयार मशीन के बजाय साफ़ वातावरण में आज़माएँ। देखें कि कहीं कोई अघोषित वैश्विक पैकेज, निजी रजिस्ट्री या स्थानीय फ़ाइल तो आवश्यक नहीं है। अगर सेटअप के लिए अकाउंट या सशुल्क सेवा चाहिए, तो पहले कमांड से पहले बताएँ।

रिपॉज़िटरी पेज से दस्तावेज़ और चित्रों के लिंक खोलें। सुनिश्चित करें कि योगदान और लाइसेंस फ़ाइलों के नाम आपकी रिपॉज़िटरी से मेल खाते हैं और टूटे लिंक हटाएँ। छोटा, सही README ऐसे आकर्षक टेम्पलेट से बेहतर है जो उन वादों से भरा हो जिन्हें आपने लागू नहीं किया।

  • प्लेसहोल्डर और बिना आधार वाले दावे हटाएँ।
  • उदाहरणों में असली टोकन, पासवर्ड और निजी URL न रखें।
  • जाँचें कि अपेक्षित आउटपुट प्रकाशित संस्करण से मेल खाता है।
  • पाठकों को बताएँ कि समस्या रिपोर्ट करते समय क्या शामिल करें।

README को लॉन्च के संक्षिप्त परिचय का आधार बनाएँ

टेम्पलेट पूरा करने के बाद छोटा परिचय निकालें: समस्या पर एक वाक्य, परिणाम का एक उदाहरण और आज़माने का एक लिंक। यही समुदाय में पोस्ट करने की शुरुआत बनेगा। मूल README को विस्तृत स्रोत बनाए रखें और हर जगह वही प्रचार अनुच्छेद दोहराने के बजाय हर परिचय पाठक के अनुसार ढालें।

सामान्य प्रश्न

यह रिपॉज़िटरी README है या प्रोफ़ाइल README?

यह टेम्पलेट सॉफ़्टवेयर रिपॉज़िटरी के लिए है। प्रोफ़ाइल README व्यक्ति का परिचय देता है और उसमें काम तथा संपर्क की पसंद जैसे अलग भाग चाहिए।

क्या मुझे ऊपर स्टार बैज जोड़ने चाहिए?

केवल तब जब वे पाठक की मदद करें। उद्देश्य और क्विक स्टार्ट प्रमुखता से रखें। बैज यह बताने का विकल्प नहीं कि प्रोजेक्ट क्या करता है।

क्या निजी प्रोजेक्ट के लिए यह टेम्पलेट इस्तेमाल कर सकता हूँ?

हाँ। सार्वजनिक सहायता लिंक को अपनी टीम के वास्तविक सहायता माध्यमों से बदलें, पहुँच की आवश्यकताएँ समझाएँ और दस्तावेज़ में क्रेडेंशियल न रखें।

संदर्भ