विषय पर बढ़ें

योगदान; योगदान; योगदान; दान करें (इस शब्द के कई अर्थ हैं, और विशिष्ट अनुवाद को संदर्भ के अनुसार निर्धारित करने की आवश्यकता है)

में योगदान करने में आपकी रुचि के लिए धन्यवाद। आप कई तरीकों से परियोजना में योगदान कर सकते हैं:

बग या अन्य मुद्दों की रिपोर्ट करें

पाया कुछ का समर्थन करना चाहिए? गलती से कुछ अप्रत्याशित व्यवहार का सामना करना पड़ा?

योगदान आम तौर पर एक चर्चा के साथ शुरू होना चाहिए। संभावित कीड़े को "संभावित मुद्दों" चर्चा के रूप में लाया जा सकता है, और सुविधा अनुरोधों को "विचारों" चर्चा के रूप में लाया जा सकता है। हम तब निर्धारित कर सकते हैं कि क्या उस चर्चा को "मुद्दों" तक बढ़ाने की आवश्यकता है, या यदि हम पुल अनुरोधों पर विचार करेंगे।

जितना संभव हो उतना विस्तार से वर्णन करें, और बग रिपोर्ट के मामले में, जितना संभव हो उतनी जानकारी प्रदान करें, जैसे:

  • ऑपरेटिंग सिस्टम प्लेटफॉर्म
  • पायथन संस्करण
  • स्थापित निर्भरता और संस्करण ( python -m pip freeze )
  • कोड स्निपेट
  • त्रुटि ट्रैकिंग बैकट्रैक

आपको हमेशा किसी भी उदाहरण को सबसे सरल संभव स्थिति में कम करने का प्रयास करना चाहिए जो समस्या को दिखाता है।

विकास; विकास

te विकसित करना शुरू करने के लिए, Hub पर te रिपॉजिटरी के लिए एक कांटा बनाएं।

फिर अपनी शाखा को क्लोन करने के लिए निम्नलिखित कमांड का उपयोग करें YOUR-USERNAME अपने Hub उपयोगकर्ता नाम से बदलें:

$ Git क्लोन https://github.com/YOUR-USERNAME/starlette

अब आप निम्न कमांड के साथ प्रोजेक्ट और इसकी निर्भरता स्थापित कर सकते हैं:

$ सीडी स्टारलेट
$ स्क्रिप्ट / स्थापित करें

परीक्षण और कोड निरीक्षण

हम अपने परीक्षण, कोड निरीक्षण और प्रलेखन निर्माण वर्कफ़्लोज़ को स्वचालित करने के लिए कस्टम शेल स्क्रिप्ट का उपयोग करते हैं।

इन परीक्षणों को चलाने के लिए, उपयोग करें:

$ स्क्रिप्ट / परीक्षण

किसी भी अन्य तर्क कोpytest में पारित किया जाएगा। अधिक जानकारी के लिए pyप्रलेखन देखें।

उदाहरण के लिए, एकल परीक्षण स्क्रिप्ट चलाना:

$ स्क्रिप्ट / परीक्षण परीक्षण / test_application.py

कोड को स्वचालित रूप से स्वरूपित करने के लिए:

$ स्क्रिप्ट / लिंट

अंत में, कोड चेक को अलग से चलाने के लिए (वेscripts/test के हिस्से के रूप में भी चलाए जाते हैं), चलाएं:

$ स्क्रिप्ट / चेक

रिकॉर्ड; दस्तावेज तैयार करें

प्रलेखन पृष्ठ पर स्थित है docs/ फ़ोल्डर के तहत।

स्थानीय रूप से एक प्रलेखन साइट चलाने के लिए (परिवर्तनों का पूर्वावलोकन करने के लिए उपयोगी), उपयोग करें:

$ स्क्रिप्ट / डॉक्स

निर्माण / निरंतर एकीकरण विफलताओं को हल करें

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

असफल पीआर प्रतिबद्ध स्थिति

यहां कुछ सामान्य तरीके दिए गए हैं जो परीक्षण सूट विफल हो सकते हैं:

जाँच कार्य विफल रहा

फेलिंग Hub एक्शन लिंट जॉब

यह नौकरी विफलता या तो एक कोड स्वरूपण समस्या या एक प्रकार एनोटेशन समस्या माध्य है। आप यह पता लगाने के लिए कार्य आउटपुट देख सकते हैं कि यह विफल क्यों हुआ, या इसे शेल में चलाएं:

$ स्क्रिप्ट / चेक

दौड़ो $ scripts/lint यह कोड को स्वचालित रूप से प्रारूपित करने के प्रयास के लायक हो सकता है, और यदि संक्रिया सफल होता है, तो परिवर्तन करें।

दस्तावेज़ कार्य विफल

यह नौकरी विफलता माध्य कि दस्तावेज़ निर्माण विफल रहा। यह कई कारणों से हो सकता है, जैसे कि अमान्य Markdown या mkdocs.yml लापता कॉन्फ़िगरेशन।

पायथन 3. एक्स नौकरी विफल रही

फेलिंग Hub एक्शन टेस्ट जॉब्स

यह नौकरी विफलता माध्य कि यूनिट परीक्षण विफल हो गया या यूनिट परीक्षण द्वारा सभी कोड पथ अधिलेखित नहीं किए गए।

यदि परीक्षण विफल हो जाता है, तो आप कवरेज रिपोर्ट के तहत यह संदेश देखेंगे:

=== 1 failed, 435 passed, 1 skipped, 1 xfailed in 11.09s ===

यदि परीक्षण सफल होता है, लेकिन कवरेज हमारी वर्तमान सीमा तक नहीं पहुंचता है, तो आप कवरेज रिपोर्ट के तहत इस संदेश को देखेंगे:

FAIL Required test coverage of 100% not reached. Total coverage: 99.00%

प्रकाशित करें; रिलीज; रिलीज

यह खंड te रखवालों पर लक्षित है।

नया संस्करण जारी करने से पहले, निम्नलिखित सामग्री के साथ एक पुल अनुरोध बनाएं:

  • चेंजलॉग के लिए एक अद्यतन:
    • हम achप्रारूप का पालन करते हैं।
    • होगा master लेबल के नवीनतम संस्करण के साथ तुलना करें और हमारे उपयोगकर्ताओं के लिए ब्याज की सभी वस्तुओं को सूचीबद्ध करें।
      • चेंजलॉग में क्या प्रलेखित किया जाना चाहिए: सुविधाओं को जोड़ा गया, बदला गया, हटा दिया गया, या हटा दिया गया, और बग फिक्स।
      • चेंजलॉग में क्या दर्ज नहीं किया जाना चाहिए: प्रलेखन, परीक्षण या उपकरण में परिवर्तन।
      • प्रभाव / महत्व के अवरोही क्रमबद्ध करना में वस्तुओं को सॉर्ट करने का प्रयास।
      • इसे संक्षिप्त और बिंदु पर रखें।🎯
  • एक संस्करण उन्नयन: देखें __version__.py ...

उदाहरण के लिए, # 1600 देखें।

एक बार एक रिलीज पीआर विलय हो जाने के बाद, एक नई रिलीज बनाई जाती है, जिसमें शामिल हैं:

  • लेबल संस्करण जैसे कि 0.13.3 ...
  • रिलीज का शीर्षक Version 0.13.3
  • परिवर्तन लॉग से प्रतिलिपि बनाने का वर्णन करता है।

एक बार बनाने के बाद, यह संस्करण स्वचालित रूप से पर अपलोड हो जाएगा।

यदि कार्य के साथ कोई समस्या है, तो आप उपयोग कर सकते हैं scripts/publish स्क्रिप्ट रिलीज संस्करण।