वर्क प्रॉडक्ट सबमिट करने से जुड़े दिशा-निर्देश

आखिरी आकलन के तौर पर, हिस्सा लेने वाले सभी योगदान देने वालों को कार्यक्रम के लिए किए गए काम का लिंक देना होगा. अगर आप सही तरीके से ऐसा नहीं करते हैं, तो हो सकता है कि यह प्रोग्राम फ़ेल हो जाए. ऐसा करने के कई तरीके हैं, इसलिए कृपया इस दस्तावेज़ को ध्यान से पढ़ें.

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

पिछले सालों में देखे गए सबसे अच्छे उदाहरण "फ़ाइनल रिपोर्ट" की तरह दिखते हैं. इस रिपोर्ट में ये चीज़ें शामिल होती हैं:

  • प्रोजेक्ट के लक्ष्यों की कम शब्दों में जानकारी.
  • आपने क्या किया.
  • मौजूदा स्थिति.
  • अब क्या करना बाकी है.
  • कौनसा कोड अपस्ट्रीम के बाद मर्ज हुआ (या नहीं).
  • प्रोजेक्ट के दौरान सीखी गई कोई भी चुनौती या अहम जानकारी.

उदाहरण देखने के लिए, 2022 की प्रोजेक्ट सूची से शुरुआत करें. बिना किसी क्रम के प्रोजेक्ट चुनें और फिर 'कोड देखें' पर क्लिक करें. कृपया ध्यान दें कि इनमें से कई प्रोजेक्ट ने हमारे सुझावों का पालन नहीं किया, जिसका मतलब है कि सिर्फ़ उन्हें अपना काम दिखाने में दिक्कत होती है.

योगदान देने वाले के लिए ध्यान दें: असाइनमेंट सबमिट करने के बाद, उसे सबमिट करने की आखिरी तारीख तक बदलाव किया जा सकता है.

आपको अपना इवैलुएशन सबमिट करने से पहले, अपने मेंटॉर के साथ यह लिंक शेयर करना चाहिए, ताकि यह पक्का किया जा सके कि यह उनकी उम्मीदों पर खरा उतरता है.

ज़रूरी शर्तें

  • आपके काम को पहचानना आसान होना चाहिए. (यानी आपके किए गए बदलाव या नया कोड.)
    • जब कोई व्यक्ति दिए गए यूआरएल पर जाता है, तो उसे यह साफ़ तौर पर पता चल जाना चाहिए कि आपने क्या काम किया है. इसके लिए, उन्हें ज़्यादा गहराई से जांच करने की ज़रूरत नहीं होनी चाहिए.
  • यह किसी स्थिर जगह पर होना चाहिए. सबमिट करने के बाद, यूआरएल को बदला नहीं जा सकता.
  • कोई दूसरा व्यक्ति आपके काम का समय बढ़ाने के लिए, लिंक के टारगेट पर मौजूद कॉन्टेंट (या उससे रेफ़र किया गया) का इस्तेमाल कर पाए.
    • अगर आपका काम 100% पूरा हो गया है, तो वे इसका इस्तेमाल कर सकते हैं.
    • अगर आपका काम पूरा नहीं हुआ है, तो आपको साफ़ तौर पर बताना होगा कि अभी क्या करना बाकी है.

सही उदाहरण

आपको ये सभी या कुछ भी करने की ज़रूरत नहीं है, लेकिन इन तरीकों से ही ये ज़रूरी शर्तें पूरी की जा सकती हैं.

  • एक ब्लॉग पोस्ट, वेब पेज या सार्वजनिक GitHub में योगदान की सुविधा वाला पेज बनाएं. इसमें आपके काम की जानकारी होती है. साथ ही, आपके किए गए कामों और डेटा स्टोर करने की जगहों के लिंक होते हैं. अगर प्रोजेक्ट पर अब भी काम बाकी है, तो उसे भी शामिल करें. इसके अलावा, हाइलाइट या चुनौती भरे काम भी शेयर किए जा सकते हैं.
    • ❗ यह सबसे अच्छा विकल्प है, क्योंकि इससे काफ़ी जानकारी आसानी से शामिल की जा सकती है. यह अच्छा है, क्योंकि इससे साफ़ तौर पर पता चलेगा कि आपने क्या काम किया है. साथ ही, इससे दूसरे लोगों के लिए आपके कोड का इस्तेमाल करना और उसे समझना आसान हो जाएगा.
  • अगर GitHub का इस्तेमाल किया जा रहा है और आपका सारा काम एक ही पुल के अनुरोध में आता है, तो उस लिंक का इस्तेमाल किया जा सकता है.
    • पक्का करें कि पुल के अनुरोध में पूरी जानकारी दी गई हो. (ब्लॉग पोस्ट के कॉन्टेंट के लिए, ऊपर दिए गए सुझाव देखें.)
    • पक्का करें कि ब्यौरे में साफ़ तौर पर बताया गया हो कि यह 'Google समर ऑफ़ कोड' के लिए है.
    • अगर जीएसओसी के खत्म होने के बाद भी पुल के अनुरोध पर ज़्यादा काम किया जाता है, तो पक्का करें कि जीएसओसी की पिछली कमिट पर कार्रवाई की गई हो.
    • ❗ इस उदाहरण में एक ही जगह पर बदलाव लॉग, किए गए टास्क की सूची, और टिप्पणियों की समीक्षा करने का फ़ायदा मिलेगा.
  • अगर GSoC के लिए, आपका GitHub रिपॉज़िटरी एक ही है, तो ज़्यादा जानकारी के साथ README.md जोड़ें.
  • सार्वजनिक तौर पर संग्रहित की गई डेवलपर ईमेल पाने वाले लोगों की सूची को ईमेल भेजें. ईमेल में ऊपर दिए गए ईमेल पते के साथ उसका लिंक भी भेजें.
  • Google Drive में सार्वजनिक फ़ोल्डर बनाएं और उसमें अपने बनाए हुए सभी पैच शामिल करें.
  • Google Sheets की मदद से सार्वजनिक स्प्रेडशीट बनाएं और अपने सभी कामों की सूची बनाएं.
  • एक बग से लिंक करें, जिसमें साफ़ तौर पर काम और बाकी सभी सही चीज़ों के रेफ़रंस शामिल हों. यह आपके सभी कामों को ट्रैक करना चाहिए. पक्का करें कि इसमें सभी कमिट की सूची हो या उन्हें ढूंढना आसान हो.
  • अपने बदलावों के यूनिफ़ाइड या कॉन्टेक्स्ट डिफ़रेंस से लिंक करें. एक ऐसा हेडर शामिल करना न भूलें जो यह बताता हो कि यह किस प्रोजेक्ट के लिए है और आप कौन हैं, ताकि यह अन्य लोगों के लिए काम का हो.

गलत उदाहरण

ये चीज़ें न करें.

  • ऐसी टारबॉल/zipफ़ाइल से लिंक करें जिसमें पूरे प्रोजेक्ट का सोर्स कोड या काम करने वाली डायरेक्ट्री हो. (बहुत से लोगों ने पहले ऐसा किया है. यह उन लोगों के लिए मददगार नहीं है जो यह समझना चाहते हैं कि आपने क्या किया.)
  • प्रोजेक्ट के प्राइमरी सोर्स रिपॉज़िटरी (डेटा स्टोर करने की जगह) में सबसे ऊपर का लिंक.
    • इसका मतलब है कि अगर cpython पर काम किया जा रहा है, तो यह लिंक काम का नहीं होगा: https://github.com/python/cpython
  • प्रोजेक्ट के सोर्स रिपॉज़िटरी के अपने क्लोन से लिंक करें.
    • इससे आपके लिए यह देखना मुश्किल हो जाता है कि आपके बदलाव क्या हैं, क्योंकि आपका काम दूसरे लोगों के साथ मिलकर काम करता है.
  • अपने GSoC प्रोजेक्ट पेज का लिंक.
    • हम पहले से ही जानते हैं कि यह क्या है. (यानी https://summerofcode.withgoogle.com/projects/#1234567890)

मेंटॉर

कृपया सही कोड सबमिट करने में अपने योगदान देने वाले की मदद करें. काम सबमिट करने की आखिरी अवधि से पहले ऐसा करना ज़रूरी है.

देखें कि...

  • सबमिशन ऊपर दी गई ज़रूरी शर्तों को पूरा करता है.
  • कोड कंपाइल होता है.
  • इस बात का दस्तावेज़ मौजूद है कि क्या और क्यों.

GSoC का आइडिया यह नहीं है कि योगदान देने वाले कोड चर्न आउट कर देते हैं. यह ज़रूरी है कि कोड, होस्ट करने वाले ओपन सोर्स प्रोजेक्ट के लिए उपयोगी हो.