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

ओपन सोर्स रिपॉज़िटरी के लिए CONTRIBUTING.md टेम्पलेट

CONTRIBUTING.md फ़ाइल किसी व्यक्ति को “मैं मदद करना चाहता हूँ” से उपयोगी इश्यू या पुल अनुरोध तक पहुँचने में मदद करती है। सबसे छोटा समर्थित योगदान और उसे सत्यापित करने का तरीका समझाएँ। आवश्यकताएँ प्रोजेक्ट के वास्तविक कामकाज को दर्शाएँ, ऐसी महत्वाकांक्षी प्रक्रिया को नहीं जिसका कोई पालन नहीं करता।

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

योगदान टेम्पलेट कॉपी करें और अपनाएँ

प्लेसहोल्डर बदलें और हर कमांड तथा लिंक सत्यापित करें। योगदानकर्ता ऐप का कोड बदलने के लिए तैयार न हो तब भी दस्तावेज़ सुधार और बग रिपोर्ट का स्वागत करें।

# योगदान देना

## शुरू करने से पहले
README पढ़ें और मौजूदा इश्यू जाँचें।
बड़े बदलावों के लिए लागू करने से पहले तरीके पर चर्चा करें।

## लोकल सेटअप
[आवश्यक रनटाइम और सत्यापित सेटअप कमांड]

## बग रिपोर्ट करें
संस्करण, परिवेश, चरण, अपेक्षित परिणाम और वास्तविक परिणाम शामिल करें।
लॉग से गोपनीय और व्यक्तिगत डेटा हटाएँ।

## पुल अनुरोध भेजें
- समस्या और प्रस्तावित बदलाव समझाएँ।
- बदलाव को केंद्रित रखें।
- [प्रोजेक्ट-विशिष्ट जाँचें] चलाएँ।
- प्रभावित दस्तावेज़ अपडेट करें।

## समीक्षा
[कौन समीक्षा करता है, कैसे जवाब दें और वास्तविक उपलब्धता]

## मदद के अन्य तरीके
[दस्तावेज़, उदाहरण, अनुवाद या दोहराई जा सकने वाली रिपोर्ट]

दिशानिर्देश आसानी से मिलने दें

GitHub रिपॉज़िटरी के रूट, docs या .github निर्देशिकाओं में योगदान दिशानिर्देश पहचानता है। README से भी फ़ाइल का लिंक दें, ताकि प्रोजेक्ट का परिचय पढ़ने वाला तुरंत प्रक्रिया ढूँढ सके।

रिपॉज़िटरी में योगदान शुरू करने के वास्तविक स्थानों से पूरा रास्ता जाँचें। कई दिशानिर्देश फ़ाइलें हों तो विरोधी निर्देशों को एकरूप करें। योगदानकर्ता को README में एक सेटअप कमांड और योगदान गाइड में अलग, असमर्थित कमांड नहीं मिलनी चाहिए।

पहले योगदान के लिए एक आसान काम तैयार करें

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

समीक्षा के लिए अपनी उपलब्धता ईमानदारी से बताएँ। जवाब देने की समय-सीमा का वादा नहीं कर सकते तो बताएँ कि योगदानकर्ता स्थिति कैसे जाँच सकते हैं। स्पष्ट सीमाएँ अधूरा छोड़ा गया काम घटाती हैं और हर योगदान मर्ज करने के वादे से अधिक उपयोगी हैं।

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

क्या CONTRIBUTING.md, README.md की जगह लेता है?

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

क्या मुझे दूसरे प्रोजेक्ट के टेस्ट कमांड कॉपी करने चाहिए?

केवल तब, जब वे आपके प्रोजेक्ट के लिए भी सही कमांड हों। प्लेसहोल्डर की जगह ऐसे कमांड रखें जिन्हें आपने वास्तव में जाँचा हो।

क्या योगदान दिशानिर्देश अधिक योगदानकर्ताओं की गारंटी देते हैं?

नहीं। वे इच्छुक लोगों की अनिश्चितता घटाते हैं, लेकिन प्रोजेक्ट की उपयोगिता, काम की गुणवत्ता और मेंटेनर की आगे की प्रतिक्रिया अब भी महत्वपूर्ण हैं।

संदर्भ