ओपन सोर्स में जाने का सबसे आसान तरीका

यह लेख कोरियाई में भी उपलब्ध है, दोह्युंग आह के लिए धन्यवाद!

थॉम पार्किन ने मेरे पहले के एक लेख की टिप्पणियों में एक महान बिंदु बनाया:

अच्छी सलाह। लेकिन आप एक बहुत ही महत्वपूर्ण [अंतिम] बिंदु से चूक गए। चूंकि यह ओपन सोर्स है, एक बार जब आप उस सुविधा/कार्य के विवरण का पता लगा लेते हैं जहां दस्तावेज़ीकरण थोड़ा हल्का होता है, तो आपको डॉक्स को अपडेट करना चाहिए और एक पूर्ण अनुरोध सबमिट करना चाहिए। इस तरह पूरे समुदाय को लाभ होता है, और आप अपनी भागीदारी के लिए कुछ "कोडर क्रेडिट" भी प्राप्त कर सकते हैं!

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

रेल, रुबिनियस और एलिक्सिर जैसी परियोजनाओं में मेरा पहला योगदान सभी को ठीक किया गया है। मैंने चीजों को स्पष्ट करने के लिए छोटे-छोटे बदलाव किए हैं, कुछ चीजें बताई हैं जिन्हें आप केवल कोड को पढ़कर ही खोज सकते हैं, यहां तक ​​​​कि केवल निश्चित टूटी हुई स्वरूपण भी। ये सभी कुछ बड़े ओपन सोर्स प्रोजेक्ट्स में मदद करने के त्वरित, आसान तरीके हैं। यहां तक ​​​​कि जब वे किसी प्रोजेक्ट में मेरा एकमात्र योगदान होते हैं, तब भी उन्होंने भविष्य के उपयोगकर्ताओं और फ्यूचर मी की मदद की है। और यही खुला स्रोत है।

दस्तावेज़ीकरण सुधार आरंभ करने का इतना अच्छा तरीका क्यों है

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

• बग को ठीक करने के लिए आपको प्रोजेक्ट सेट करने की आवश्यकता नहीं है . चूंकि आप केवल दस्तावेज़ीकरण को अपडेट कर रहे हैं, इसलिए आपको परीक्षण या ऐप चलाने की आवश्यकता नहीं है। कभी-कभी, आपको प्रोजेक्ट को अपनी मशीन पर क्लोन भी नहीं करना पड़ता है - आप अपना परिवर्तन सीधे GitHub पर कर सकते हैं!

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

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

• आखिरकार, आप कम प्रभाव वाले बदलाव के साथ अनुरक्षक के साथ संबंध बनाना शुरू कर रहे हैं . आप परियोजना की दिशा नहीं बदल रहे हैं, जैसे कि यदि आप एक संपूर्ण सुविधा का योगदान कर रहे हैं। इसलिए एक अनुरक्षक के लिए आपके परिवर्तन की समीक्षा करना आसान है, और वे आमतौर पर आपको अधिक तेज़ी से प्रतिक्रिया देंगे। आपका मर्ज अनुरोध "क्या यह एक अच्छा विचार है?" चरण।

जैसे-जैसे आप उस संबंध को बनाते रहेंगे, आपको एक विश्वसनीय योगदानकर्ता के रूप में देखा जाने लगेगा। आपके पुल अनुरोधों की तेजी से समीक्षा की जाएगी, और आप दोनों के लिए अधिक जटिल सुविधा अनुरोधों और बग समाधान के माध्यम से बात करना आसान होगा।

उन्हें शुरू करना आसान है, उन्हें करना आसान है, और वे अधिक तेज़ी से विलय हो जाते हैं। तो आपका पहला योगदान दस्तावेज़ समाधान क्यों नहीं होगा?

अपडेट किए गए दस्तावेज़ीकरण का वापस योगदान कैसे शुरू करें

दस्तावेज़ अपडेट में योगदान देने का एक महत्वपूर्ण तरीका बग को ठीक करना है:वे दोनों उन चीज़ों के प्रति संवेदनशील होने पर भरोसा करते हैं जो गलत लगती हैं . आपको ध्यान देना होगा।

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

एक बार जब आपको इस बात का अच्छा अंदाजा हो जाए कि बदलाव कहां करना है और आप इसे कैसे शब्द देना चाहते हैं, तो अपना बदलाव करें और GitHub के माध्यम से एक पुल अनुरोध भेजें।

यदि आप अभी भी डॉक्स को अपडेट करने का सबसे अच्छा तरीका तय करने का प्रयास कर रहे हैं, तो GitHub पर एक समस्या खोलें। यह कुछ इस तरह हो सकता है:

"अरे, यह मेरे लिए भ्रमित करने वाला था। मैं कुछ इस तरह दिखने के लिए इसे अपडेट करने के बारे में सोच रहा था:... आप क्या सोचते हैं? मुझे और कुछ का जिक्र करना चाहिए?" साथ में, आप ऐसे शब्द बना सकते हैं जो सभी को संतुष्ट करें।

अंत में, यदि आपको कोई प्रतिक्रिया नहीं मिलती है तो निराश न हों। बड़ी परियोजनाओं में बहुत कुछ चल रहा है, इसलिए आपके योगदान को दरार से गिरना आसान है। एक या दो सप्ताह में, यदि आप अभी भी किसी से नहीं सुनते हैं, तो अनुरक्षक से फिर से पूछें ।

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

इसलिए जब आप अपने द्वारा उपयोग किए जाने वाले कोड के बारे में भ्रमित हों, या स्रोत में गोता लगाना चाहते हैं, तो अगले व्यक्ति के लिए इसे आसान बनाएं। एक त्वरित अपडेट लिखें, और इसे वापस योगदान दें। ओपन सोर्स योगदानकर्ता बनने का यह सबसे आसान तरीका है।

यह लेख मूल रूप से मेरी सूची के लोगों को भेजा गया था। इसे और अधिक पढ़ने के लिए, यहाँ साइन अप करें!