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