में योगदान Ultralytics खुला स्रोत YOLO खजाने

योगदान करने में आपकी रुचि के लिए धन्यवाद Ultralytics खुला स्त्रोत YOLO खजाने! आपका योगदान परियोजना को बढ़ाएगा और पूरे समुदाय को लाभान्वित करेगा। यह दस्तावेज़ आरंभ करने में आपकी मदद करने के लिए दिशानिर्देश और सर्वोत्तम अभ्यास प्रदान करता है।

विषय-सूची

1. आचार संहिता
2. पुल अनुरोधों के माध्यम से योगदान करना
   • सीएलए साइनिंग
   • Google-स्टाइल डॉकस्ट्रिंग
   • GitHub क्रियाहरू CI परीक्षण
3. रिपोर्टिंग बग
4. लाइसेंस
5. समाप्ति

आचार संहिता

सभी योगदानकर्ताओं को सभी के लिए एक स्वागत योग्य और समावेशी वातावरण सुनिश्चित करने के लिए आचार संहिता का पालन करना चाहिए।

पुल अनुरोधों के माध्यम से योगदान करना

हम पुल अनुरोधों के रूप में योगदान का स्वागत करते हैं। समीक्षा प्रक्रिया को कारगर बनाने के लिए, कृपया इन दिशानिर्देशों का पालन करें:

1. रिपॉजिटरी को फोर्क करें: फोर्क Ultralytics YOLO आपके GitHub खाते का भंडार।

2. एक शाखा बनाएँ: अपने परिवर्तनों के लिए एक वर्णनात्मक नाम के साथ अपने फोर्कड रिपॉजिटरी में एक नई शाखा बनाएं।

3. अपने परिवर्तन करें: सुनिश्चित करें कि आपके परिवर्तन प्रोजेक्ट की कोडिंग शैली का पालन करते हैं और नई त्रुटियां या चेतावनियां पेश नहीं करते हैं।

4. अपने परिवर्तनों का परीक्षण करें: यह सुनिश्चित करने के लिए स्थानीय रूप से अपने परिवर्तनों का परीक्षण करें कि वे अपेक्षानुसार काम करते हैं और नई समस्याएं पेश न करें।

5. अपने परिवर्तन करें: वर्णनात्मक प्रतिबद्ध संदेश के साथ अपने परिवर्तन करें. अपने प्रतिबद्ध संदेश में कोई भी प्रासंगिक समस्या संख्या शामिल करें।

6. एक पुल अनुरोध बनाएं: अपने फोर्क किए गए भंडार से मुख्य तक एक पुल अनुरोध बनाएं Ultralytics YOLO कोष। अपने परिवर्तनों की स्पष्ट व्याख्या प्रदान करें और वे परियोजना को कैसे सुधारते हैं।

सीएलए साइनिंग

इससे पहले कि हम आपके पुल अनुरोध को स्वीकार कर सकें, आपको एक योगदानकर्ता लाइसेंस समझौते (सीएलए) पर हस्ताक्षर करना होगा। यह कानूनी दस्तावेज़ सुनिश्चित करता है कि आपके योगदान को ठीक से लाइसेंस प्राप्त है और परियोजना को AGPL-3.0 लाइसेंस।

सीएलए पर हस्ताक्षर करने के लिए, अपना पीआर जमा करने के बाद सीएलए बॉट द्वारा दिए गए निर्देशों का पालन करें और अपने पीआर में एक टिप्पणी जोड़ें:

I have read the CLA Document and I sign the CLA

Google-स्टाइल डॉकस्ट्रिंग

नए फ़ंक्शन या कक्षाएं जोड़ते समय, एक Google-style docstring अन्य डेवलपर्स के लिए स्पष्ट और संक्षिप्त प्रलेखन प्रदान करने के लिए। इससे यह सुनिश्चित करने में मदद मिलती है कि आपके योगदान को समझना और बनाए रखना आसान है।

def example_function(arg1, arg2=4):
    """
    Example function that demonstrates Google-style docstrings.

    Args:
        arg1 (int): The first argument.
        arg2 (int): The second argument. Default value is 4.

    Returns:
        (bool): True if successful, False otherwise.

    Examples:
        >>> result = example_function(1, 2)  # returns False
    """
    if arg1 == arg2:
        return True
    return False

def example_function(arg1: int, arg2: int = 4) -> bool:
    """
    Example function that demonstrates Google-style docstrings.

    Args:
        arg1: The first argument.
        arg2: The second argument. Default value is 4.

    Returns:
        True if successful, False otherwise.

    Examples:
        >>> result = example_function(1, 2)  # returns False
    """
    if arg1 == arg2:
        return True
    return False

def example_small_function(arg1: int, arg2: int = 4) -> bool:
    """Example function that demonstrates a single-line docstring."""
    return arg1 == arg2

GitHub क्रियाहरू CI परीक्षण

इससे पहले कि आपके पुल अनुरोध को मर्ज किया जा सके, सभी GitHub क्रियाएँ निरंतर एकीकरण (CI) परीक्षण पास होने चाहिए। इन परीक्षणों में लाइनिंग, यूनिट परीक्षण और अन्य जांच शामिल हैं ताकि यह सुनिश्चित किया जा सके कि आपके परिवर्तन परियोजना के गुणवत्ता मानकों को पूरा करते हैं। GitHub कार्रवाइयों के आउटपुट की समीक्षा करें और किसी भी समस्या को ठीक करें।

रिपोर्टिंग बग

हम बग रिपोर्ट की सराहना करते हैं क्योंकि वे परियोजना की गुणवत्ता बनाए रखने में महत्वपूर्ण भूमिका निभाते हैं। बग की रिपोर्ट करते समय, न्यूनतम प्रतिलिपि प्रस्तुत करने योग्य उदाहरण प्रदान करना महत्वपूर्ण है: एक स्पष्ट, संक्षिप्त कोड उदाहरण जो समस्या को दोहराता है। यह बग की त्वरित पहचान और समाधान में मदद करता है।

लाइसेंस

Ultralytics गले लगाता है GNU Affero जनरल पब्लिक लाइसेंस v3.0 (AGPL-3.0) इसके रिपॉजिटरी के लिए, सॉफ्टवेयर विकास में खुलेपन, पारदर्शिता और सहयोगी वृद्धि को बढ़ावा देना। यह मजबूत कॉपीलेफ्ट लाइसेंस सुनिश्चित करता है कि सभी उपयोगकर्ता और डेवलपर्स सॉफ़्टवेयर का उपयोग करने, संशोधित करने और साझा करने की स्वतंत्रता बनाए रखें। यह सामुदायिक सहयोग को बढ़ावा देता है, यह सुनिश्चित करता है कि कोई भी सुधार सभी के लिए सुलभ रहे।

उपयोगकर्ताओं और डेवलपर्स को की शर्तों के साथ खुद को परिचित करने के लिए प्रोत्साहित किया जाता है AGPL-3.0 प्रभावी ढंग से और नैतिक रूप से योगदान करने के लिए Ultralytics ओपन-सोर्स समुदाय।

समाप्ति

योगदान करने में आपकी रुचि के लिए धन्यवाद Ultralytics खुला स्रोत YOLO परियोजनाओं। आपकी भागीदारी हमारे सॉफ्टवेयर के भविष्य को आकार देने और नवाचार और सहयोग के समुदाय को बढ़ावा देने में महत्वपूर्ण है। चाहे आप कोड में सुधार कर रहे हों, बग की रिपोर्ट कर रहे हों, या सुविधाओं का सुझाव दे रहे हों, आपके योगदान महत्वपूर्ण प्रभाव डालते हैं।

हम आपके विचारों को कार्रवाई में देखने के लिए तत्पर हैं और ऑब्जेक्ट डिटेक्शन तकनीक को आगे बढ़ाने के लिए आपकी प्रतिबद्धता की सराहना करते हैं। आइए इस रोमांचक ओपन-सोर्स यात्रा में एक साथ बढ़ना और नया करना जारी रखें। हैप्पी कोडिंग! 🚀🌟

अक्सर पूछे जाने वाले प्रश्न

मुझे इसमें योगदान क्यों देना चाहिए Ultralytics YOLO ओपन-सोर्स रिपॉजिटरी?

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

मैं योगदानकर्ता लाइसेंस समझौते (सीएलए) पर हस्ताक्षर कैसे करूं Ultralytics YOLO?

योगदानकर्ता लाइसेंस समझौते (सीएलए) पर हस्ताक्षर करने के लिए, अपना पुल अनुरोध सबमिट करने के बाद सीएलए बॉट द्वारा दिए गए निर्देशों का पालन करें। यह सुनिश्चित करेगा कि आपके योगदान के तहत उचित रूप से लाइसेंस प्राप्त है AGPL-3.0 लाइसेंस, ओपन-सोर्स प्रोजेक्ट की कानूनी अखंडता को बनाए रखना। अपने पुल अनुरोध में एक टिप्पणी जोड़ें:

I have read the CLA Document and I sign the CLA

अधिक जानकारी के लिए, CLA हस्ताक्षर अनुभाग देखें.

क्या हैं Google-style docstrings और उनके लिए क्यों आवश्यक हैं Ultralytics YOLO योगदान?

Google-style docstrings कार्यों और कक्षाओं के लिए स्पष्ट और संक्षिप्त प्रलेखन प्रदान करते हैं, कोड की पठनीयता और रखरखाव को बढ़ाते हैं। ये डॉकस्ट्रिंग फ़ंक्शन के उद्देश्य, तर्कों और विशिष्ट स्वरूपण नियमों के साथ मानों की वापसी को रेखांकित करते हैं। योगदान करते समय Ultralytics YOLO, का पालन करना Google-style docstrings सुनिश्चित करता है कि आपके जोड़ समझने योग्य और अच्छी तरह से प्रलेखित हैं। उदाहरण और दिशानिर्देशों के लिए, पर जाएँ Google-Style Docstrings सेक्शन।

मैं कैसे सुनिश्चित कर सकता हूं कि मेरे परिवर्तन GitHub एक्शन CI परीक्षण पास करते हैं?

आपके पुल अनुरोध को मर्ज करने से पहले, इसे सभी GitHub क्रियाओं सतत एकीकरण (CI) परीक्षणों को पास करना होगा। इन परीक्षणों में लाइनिंग, यूनिट परीक्षण और अन्य जांच शामिल हैं ताकि यह सुनिश्चित किया जा सके कि कोड परियोजना के गुणवत्ता मानकों को पूरा करता है। GitHub कार्रवाइयों के आउटपुट की समीक्षा करें और किसी भी समस्या का समाधान करें। CI प्रक्रिया और समस्या निवारण युक्तियों के बारे में विस्तृत जानकारी के लिए, GitHub क्रियाएँ CI परीक्षण अनुभाग देखें।

मैं बग की रिपोर्ट कैसे करूं Ultralytics YOLO खजाने?

बग की रिपोर्ट करने के लिए, अपनी बग रिपोर्ट के साथ एक स्पष्ट और संक्षिप्त न्यूनतम प्रतिलिपि प्रस्तुत करने योग्य उदाहरण प्रदान करें। इससे डेवलपर्स को समस्या को जल्दी से पहचानने और ठीक करने में मदद मिलती है। सुनिश्चित करें कि आपका उदाहरण न्यूनतम है फिर भी समस्या को दोहराने के लिए पर्याप्त है। बग की रिपोर्ट करने के बारे में अधिक विस्तृत चरणों के लिए, रिपोर्टिंग बग अनुभाग देखें।

टिप्पणियाँ