यह लेख कोरियाई में भी उपलब्ध है, डोहयुंग आह्न का धन्यवाद!
थॉम पार्किन ने मेरे पहले के एक लेख की टिप्पणियों में एक शानदार बात कही:
बहुत अच्छी सलाह। लेकिन आप एक बहुत महत्वपूर्ण [अंतिम] बिंदु चूक गए। चूंकि यह ओपन सोर्स है, एक बार जब आप उस फीचर/फंक्शन के विवरण का पता लगा लेते हैं जहां डॉक्यूमेंटेशन थोड़ा हल्का है, तो आपको डॉक्स को अपडेट करना चाहिए और एक पुल रिक्वेस्ट सबमिट करना चाहिए। इस तरह पूरा समुदाय लाभान्वित होता है, और आप अपनी भागीदारी के लिए कुछ "कोडर क्रेड" भी अर्जित कर सकते हैं!
मुझे खुशी है कि थॉम ने इसका उल्लेख किया, क्योंकि यह बहुत महत्वपूर्ण है। डॉक्यूमेंटेशन ठीक करना उन परियोजनाओं में योगदान देना शुरू करने का सबसे आसान तरीका है जिनका आप उपयोग करते हैं और प्यार करते हैं।
रेल्स, रूबिनियस, और एलिक्सिर जैसी परियोजनाओं में मेरा पहला योगदान सभी डॉक फिक्स थे। मैंने चीजों को स्पष्ट करने के लिए छोटे-छोटे बदलाव किए, कुछ चीजों को समझाया जिन्हें आप केवल कोड पढ़कर खोज सकते थे, यहां तक कि सिर्फ टूटे हुए फॉर्मेटिंग को ठीक किया। ये सभी कुछ बड़ी ओपन सोर्स परियोजनाओं की मदद करने के त्वरित, आसान तरीके रहे हैं। यहां तक कि जब वे किसी परियोजना में मेरे एकमात्र योगदान रहे हैं, तब भी उन्होंने भविष्य के उपयोगकर्ताओं, और फ्यूचर मी की मदद की है। और यही ओपन सोर्स के बारे में है।
डॉक्यूमेंटेशन फिक्स शुरू करने का इतना शानदार तरीका क्यों हैं
डॉक फिक्स रेल्स जैसी बड़ी परियोजना में योगदान देने का सबसे कम डराने वाला तरीका है:
बग ठीक करने के लिए आपको परियोजना सेट अप करने की आवश्यकता नहीं है। चूंकि आप केवल डॉक्यूमेंटेशन अपडेट कर रहे हैं, आपको टेस्ट या ऐप चलाने की आवश्यकता नहीं है। कभी-कभी, आपको अपनी मशीन पर परियोजना को क्लोन करने की भी आवश्यकता नहीं होगी—आप GitHub पर ही अपना बदलाव कर सकते हैं!
यदि मेन्टेनर आपसे अपने पुल रिक्वेस्ट में बदलाव करने के लिए कहता है, तो वे आमतौर पर शब्दों या स्वाद के मामले होते हैं। उस तरह के बदलाव आपके कोड की आलोचना की तुलना में पचाने में आसान हो सकते हैं। और उन्हें करना आपके लिए आसान है, क्योंकि आपको टेस्ट या कोड अपडेट नहीं करने पड़ते, केवल शब्द।
डॉक्यूमेंटेशन एक परियोजना मेन्टेनर के लिए कठिन है, इसलिए अपडेट की सराहना की जाती है। अक्सर, लेखक कोड के बहुत करीब होते हैं ताकि वे समझ सकें कि भ्रमित करने वाले हिस्से कहां हैं। उन्हें अन्य, नए डेवलपर्स की आवश्यकता होती है जो उन्हें बताएं कि डॉक्स को कहां मदद की ज़रूरत है। अपनी परियोजना को एक शुरुआती के रूप में देखने का अभ्यास करना पड़ता है, और हर किसी ने वह कौशल नहीं बनाया है।
अंत में, आप एक कम-प्रभाव वाले बदलाव के साथ मेन्टेनर के साथ संबंध बनाना शुरू कर रहे हैं। आप परियोजना की दिशा नहीं बदल रहे हैं, जैसे आप एक पूरी फीचर योगदान करके करेंगे। इसलिए आपका बदलाव मेन्टेनर के लिए समीक्षा करना आसान है, और वे आमतौर पर आपको अधिक तेज़ी से प्रतिक्रिया देंगे। आपका मर्ज रिक्वेस्ट "क्या यह एक अच्छा विचार है?" चरण में अटक नहीं जाएगा।
जैसे-जैसे आप उस संबंध को बनाए रखते हैं, आप एक विश्वसनीय योगदानकर्ता के रूप में देखे जाने लगेंगे। आपके पुल रिक्वेस्ट तेजी से समीक्षा किए जाएंगे, और आप दोनों के लिए अधिक जटिल फीचर अनुरोधों और बग फिक्स के माध्यम से बात करना आसान होगा।
वे शुरू करने में आसान हैं, करने में आसान हैं, और वे अधिक तेज़ी से मर्ज होते हैं। तो आपका पहला योगदान डॉक फिक्स क्यों नहीं होगा?
अपडेटेड डॉक्यूमेंटेशन योगदान करना शुरू कैसे करें
डॉक अपडेट में योगदान देना बग ठीक करने की तरह एक महत्वपूर्ण तरीके से है: वे दोनों उन चीजों के प्रति संवेदनशील होने पर निर्भर करते हैं जो गलत लगती हैं। आपको ध्यान देना होगा।
जब आप अप्रत्याशित व्यवहार में भाग लेते हैं, तो शायद डॉक्स को अपडेट करने का समय आ गया है। अगर आपको किसी समस्या को हल करने के लिए कोड में गोता लगाना पड़ता है, तो आप शायद इसके बारे में अन्य लोगों को भी बताना चाहेंगे। आपको डॉक्यूमेंटेशन में टूटे फॉर्मेटिंग और टाइपो के प्रति भी संवेदनशील होना चाहिए। अगर आप इसे ठीक नहीं करने जा रहे हैं, तो कौन करेगा?
एक बार जब आपको इस बात का अच्छा अंदाजा हो जाए कि बदलाव कहां करना है और आप इसे कैसे शब्दबद्ध करना चाहते हैं, तो अपना बदलाव करें और GitHub के माध्यम से एक पुल रिक्वेस्ट भेजें।
यदि आप अभी भी डॉक्स को अपडेट करने का सबसे अच्छा तरीका तय करने की कोशिश कर रहे हैं, तो GitHub पर एक इश्यू खोलें। यह कुछ इस तरह हो सकता है:
"अरे, यह मेरे लिए भ्रमित करने वाला था। मैं इसे ऐसा कुछ दिखाने के लिए अपडेट करने के बारे में सोच रहा था: ... आप क्या सोचते हैं? क्या और कुछ मुझे उल्लेख करना चाहिए?" साथ में, आप ऐसा शब्दबद्ध कर सकते हैं जो सभी को संतुष्ट करे।
अंत में, निराश न हों अगर आपको कोई प्रतिक्रिया नहीं मिलती। बड़ी परियोजनाओं में बहुत कुछ चल रहा होता है, इसलिए आपके योगदान का दरार से गिर जाना आसान है। एक सप्ताह या उसके बाद, यदि आप अभी भी किसी से नहीं सुनते हैं, तो मेन्टेनर से फिर से पूछें।
डॉक्यूमेंटेशन अक्सर पहली चीज होती है जिसका आप सामना करते हैं जब आप एक लाइब्रेरी के साथ काम करते हैं, इसलिए यह महत्वपूर्ण है कि यह विस्तृत और स्पष्ट हो।
तो जब आप अपने द्वारा उपयोग किए जाने वाले कोड के बारे में भ्रमित हों, या स्रोत में गोता लगाना पड़े, तो अगले व्यक्ति के लिए इसे आसान बनाएं। एक त्वरित अपडेट लिखें, और इसे वापस योगदान दें। यह ओपन सोर्स योगदानकर्ता बनने का सबसे आसान तरीका है जिसे मैं जानता हूँ।
यह लेख मूल रूप से मेरी सूची के लोगों को भेजा गया था। इस तरह के और अधिक पढ़ने के लिए, यहाँ साइन अप करें!
