सामग्री पर जाएं

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

Thank you for your interest in contributing to Ultralytics open-source YOLO repositories! Your contributions will enhance the project and benefit the entire community. This document provides guidelines and best practices to help you get started.

विषय-सूची

  1. आचार संहिता
  2. पुल अनुरोधों के माध्यम से योगदान करना
  3. रिपोर्टिंग बग
  4. लाइसेंस
  5. समाप्ति

आचार संहिता

All contributors must adhere to the Code of Conduct to ensure a welcoming and inclusive environment for everyone.

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

We welcome contributions in the form of pull requests. To streamline the review process, please follow these guidelines:

  1. Fork the repository: Fork the Ultralytics YOLO repository to your GitHub account.

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

  3. Make your changes: Ensure that your changes follow the project's coding style and do not introduce new errors or warnings.

  4. Test your changes: Test your changes locally to ensure they work as expected and do not introduce new issues.

  5. Commit your changes: Commit your changes with a descriptive commit message. Include any relevant issue numbers in your commit message.

  6. Create a pull request: Create a pull request from your forked repository to the main Ultralytics YOLO repository. Provide a clear explanation of your changes and how they improve the project.

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

Before we can accept your pull request, you must sign a Contributor License Agreement (CLA). This legal document ensures that your contributions are properly licensed and that the project can continue to be distributed under the AGPL-3.0 license.

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

I have read the CLA Document and I sign the CLA

Google-शैली के डॉकस्ट्रिंग

When adding new functions or classes, include a Google-style docstring to provide clear and concise documentation for other developers. This helps ensure your contributions are easy to understand and maintain.

उदाहरण डॉकस्ट्रिंग

यह उदाहरण एक Google-शैली डॉकस्ट्रिंग दिखाता है। ध्यान दें कि इनपुट और आउटपुट दोनों types must always be enclosed by parentheses, i.e., (bool).

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

This example shows both a Google-style docstring and argument and return type hints, though both are not required; one can be used without the other.

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

Smaller or simpler functions can utilize a single-line docstring. Note the docstring must use 3 double-quotes and be a complete sentence starting with a capital letter and ending with a period.

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

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

Before your pull request can be merged, all GitHub Actions Continuous Integration (CI) tests must pass. These tests include linting, unit tests, and other checks to ensure your changes meet the project's quality standards. Review the output of the GitHub Actions and fix any issues.

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

We appreciate bug reports as they play a crucial role in maintaining the project's quality. When reporting bugs, it is important to provide a Minimum Reproducible Example: a clear, concise code example that replicates the issue. This helps in quick identification and resolution of the bug.

लाइसेंस

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

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

समाप्ति

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

We look forward to seeing your ideas in action and appreciate your commitment to advancing object detection technology. Let's continue to grow and innovate together in this exciting open-source journey. Happy coding! 🚀🌟



Created 2023-11-12, Updated 2024-06-08
Authors: UltralyticsAssistant (1), glenn-jocher (7)

टिप्पणियाँ