इस पेज में, Docs के Google सीज़न के लिए स्वीकार किए गए तकनीकी राइटिंग प्रोजेक्ट की जानकारी दी गई है.
प्रोजेक्ट की खास जानकारी
- ओपन सोर्स संगठन:
- SymPy
- तकनीकी लेखक:
- Soumi7
- प्रोजेक्ट का नाम:
- सभी docstrings में एक जैसा रहना - Sympy दस्तावेज़
- प्रोजेक्ट की अवधि:
- मानक अवधि (तीन महीने)
प्रोजेक्ट का विवरण
संक्षेप :
Sympy दस्तावेज़ और पिछले काम की मौजूदा स्थिति :
SymPy की आधिकारिक स्टाइल गाइड बनाने का काम पूरा हो गया है.
लॉरेन ग्लाटली के GSoD प्रोजेक्ट ने SymPy docstrings के लिए एक स्टाइल गाइड बनाई है. इसे SymPy डॉक्यूमेंटेशन स्टाइल गाइड में देखा जा सकता है.
नई स्टाइल गाइड में दिए गए दिशा-निर्देशों का लगातार पालन करने के लिए, खास सबमॉड्यूल औरSolvers.py फ़ाइल में मौजूद docstrings में बदलाव किया गया है
इसके बाद भी, कोडबेस की अन्य सभी डॉकस्ट्रिंग में बदलाव किया जाना बाकी था, ताकि नई स्टाइल गाइड का पालन किया जा सके.
प्रस्तावित काम :
SymPy की ज़्यादातर डॉकस्ट्रिंग, अब भी सबसे नई स्टाइल गाइड का पालन नहीं करती हैं. इस प्रोजेक्ट का मकसद, SymPy में पूरी दस्तावेज़ स्ट्रिंग को अपडेट करना है, ताकि इस गाइड का पालन किया जा सके.
मैंने मेंटॉर से इस प्रोजेक्ट के बारे में बात की. यहां चर्चा का लिंक दिया गया है.
यह फ़ैसला लिया गया कि नई स्टाइल गाइड का पालन करने के लिए, सिंपी के कोड बेस में डॉकस्ट्रिंग में बदलाव करना एक बड़ा काम है और प्रोजेक्ट इसी तक सीमित होना चाहिए.
इस प्रोजेक्ट पर मेरे काम में, मौजूदा डॉकस्ट्रिंग को अपडेट करने के लिए नई गाइड लागू करना शामिल है. साथ ही, भाषा के इस्तेमाल या शर्तों जैसी दिक्कतों को इकट्ठा करके उन्हें ठीक करना भी शामिल है.
मौजूदा सब-सेक्शन के क्रम को बाद में या एक अलग टास्क के तौर पर बदला या तय किया जा सकता है.
पैरामीटर सेक्शन में अतिरिक्त उदाहरण जोड़कर, पैरामीटर में अलग-अलग वैल्यू पास किए जाने पर नतीजों में अंतर दिखाना.
गॉचा और कमियां वाले सेक्शन में मुश्किल उदाहरण जोड़ते रहें.
योगदान: - #17887 : समस्या #17887 पर काम किया गया: खास सबमॉड्यूल में वे docstring सेक्शन जोड़ें जो मौजूद नहीं हैं. मैंने स्पेशल सबमॉड्यूल के कुछ फ़ंक्शन में, पैरामीटर और उदाहरण वाले सेक्शन जोड़े नहीं थे, जिनमें L ने बदलाव किया था. नई स्टाइल गाइड का पालन करें और आने वाले समय में डॉकस्ट्रिंग के लिए एक मॉडल के तौर पर काम करें.
मेरे मर्ज किए गए PR का लिंक यह है : https://github.com/SIMpy/SIMpy/pull/19334
- #19591 : अंक #19591 डॉक्यूमेंटेशन स्टाइल गाइड को ट्रैक करता है. मैंने कोर.सिंपिफ़ाई docstring में बदलाव करने के लिए पीआर जोड़ी है, ताकि नई स्टाइल गाइड का पालन किया जा सके. मैंने अलग-अलग पैरामीटर के इस्तेमाल के बारे में स्ट्रक्चर्ड एक्सप्लेनेशंस और उदाहरण जोड़े हैं.
यहां पीआर का लिंक दिया गया है: https://github.com/SIMpy/simpy/pull/19613
प्रोजेक्ट के लक्ष्य
टाइमलाइन 17 अगस्त से पहले :
- संगठन में योगदान देना जारी रखें.
- उपयोगकर्ता के दस्तावेज़ और सिंपी के मौजूदा वर्शन के बारे में ज़्यादा जानें.
- ऐसी तकनीकें और कौशल सीखें, जिनसे प्रोजेक्ट को लागू करने में मदद मिलेगी.
कम्यूनिटी के साथ रिश्ता : (17 अगस्त से 13 सितंबर, 2020)
- समय के अंतर की वजह से, बातचीत का चैनल और समय सेट अप करें.
- अपने लक्ष्यों को बेहतर बनाना और दोनों तरफ़ उम्मीदें सेट करना.
- मॉड्यूल अपडेट करने के क्रम के बारे में बताना.
- मॉड्यूल में बदलाव करने के क्रम को फ़ाइनल करें, ताकि वे सबसे नई डॉकस्ट्रिंग स्टाइल गाइड के मुताबिक हों.
दस्तावेज़ की अवधि(14 सितंबर, 2020 से 30 नवंबर, 2020) :
हर हफ़्ते हासिल करने के लिए लक्ष्य सेट करें. हर हफ़्ते या उससे ज़्यादा समय में, एक मॉड्यूल या सबमॉड्यूल की डॉकस्ट्रिंग पूरी करें.
इन सभी मॉड्यूल के लिए, मेरा मुख्य लक्ष्य नए स्टाइल गाइड का पालन करने के लिए, छूटे हुए सेक्शन जोड़ना और डॉकस्ट्रिंग को फिर से तैयार करना होगा. इसमें, पैरामीटर में अलग-अलग वैल्यू पास किए जाने पर मिलने वाले अलग-अलग नतीजे शामिल होंगे. पेचीदा आउटपुट, गॉचास और पिटफ़ॉल सेक्शन में जोड़ दिए जाएंगे.
पहला हफ़्ता ( 14 सितंबर से 21 सितंबर) : कोर
दूसरा हफ़्ता (22 सितंबर से 29 सितंबर) : फ़ंक्शन : सबमॉड्यूल का कॉम्बिनेशन
तीसरा हफ़्ता (30 सितंबर से 6 अक्टूबर) : फ़ंक्शन
चौथा हफ़्ता (7 अक्टूबर से 14 अक्टूबर) : आसान बनाएं, क्रिप्टो करंसी
पांचवां हफ़्ता (15 अक्टूबर से 21 अक्टूबर) : डायाफ़ेंटाइन
छठा हफ़्ता (22 अक्टूबर से 29 अक्टूबर):होलोनॉमिक :ऑपरेशन सबमॉड्यूल
सातवां हफ़्ता (30 अक्टूबर से 7 नवंबर) : Integrals मॉड्यूल(integrals.integrals), मीजर G-फ़ंक्शन का इस्तेमाल करके इंटिग्रल की गणना करना
आठवां हफ़्ता (8 नवंबर से 15 नवंबर) : फ़िज़िक्स, कैटगरी मॉड्यूल के आखिर में फ़ंक्शन, कोड जनरेशन मॉड्यूल, सबमॉड्यूल खास
9वां हफ़्ता (16 नवंबर से 23 नवंबर) : भौतिक विज्ञान, कैटगरी मॉड्यूल के आखिर में फ़ंक्शन, कोड जनरेशन मॉड्यूल, सबमॉड्यूल खास
10वां हफ़्ता (24 नवंबर से 30 नवंबर) : गॉचा और गलतियां सेक्शन
30 नवंबर - 5 दिसंबर, 2020 को 18:00 यूटीसी पर : फ़ाइनल प्रोजेक्ट सबमिट करना और रिपोर्ट लिखना
3 से 10 दिसंबर, 2020 को 18:00 बजे यूटीसी पर : प्रोजेक्ट को सफल बनाने और मेंटॉर के साथ काम करने का अनुभव सबमिट करना
यहां बताए गए मॉड्यूल का क्रम, मेंटॉर के साथ चर्चा करने के बाद बदला जा सकता है.
मेंटॉर के सुझाव के मुताबिक, हम पहले उन मॉड्यूल को अपडेट करने पर फ़ोकस करेंगे जिन्हें आसानी से अपडेट किया जा सकता है. इसके बाद, मुश्किल मॉड्यूल वाले मॉड्यूल पर ध्यान दें.
इस प्रोजेक्ट के लिए मैं सही व्यक्ति क्यों हूं?
मुझे इस प्रोजेक्ट के लिए सही व्यक्ति मानना है, क्योंकि मुझे कंप्यूटर साइंस की तकनीकी फ़ील्ड में लिखने का पहले से अनुभव है. साथ ही, मुझे git और GitHub से जुड़ी जानकारी है.
मैंने PRs को सिंपी की नई स्टाइल गाइड में दस्तावेज़ अपडेट करने के लिए सबमिट कर दिया है. इसलिए, मुझे वर्कफ़्लो को लेकर भरोसा है. साथ ही, मुझे नियमित तौर पर योगदान मिल रहा है.
शुरुआत में जब मैंने योगदान देना शुरू किया, तो मुझे कुछ गड़बड़ियों का सामना करना पड़ा. आखिरकार, मुझे हर बार टेस्ट करने और दस्तावेज़ बनाने की आदत हो गई, क्योंकि यह बहुत ज़रूरी है.
मैं इस प्रोजेक्ट में योगदान देने में बहुत सहज हूं और इसके लिए तैयार हूं.