ultralytics/docs/en/help/contributing.md

comments	description	keywords
true	Learn how to contribute to Ultralytics YOLO open-source repositories. Follow guidelines for pull requests, code of conduct, and bug reporting.	Ultralytics, YOLO, open-source, contribution, pull request, code of conduct, bug reporting, GitHub, CLA, Google-style docstrings, AGPL-3.0

Contributing to Ultralytics Open-Source Projects

Welcome! We're thrilled that you're considering contributing to our Ultralytics open-source projects. Your involvement not only helps enhance the quality of our repositories but also benefits the entire computer vision community. This guide provides clear guidelines and best practices to help you get started.

Watch: How to Contribute to Ultralytics Repository | Ultralytics Models, Datasets and Documentation 🚀

🤝 Code of Conduct

To ensure a welcoming and inclusive environment for everyone, all contributors must adhere to our Code of Conduct. Respect, kindness, and professionalism are at the heart of our community.

🚀 Contributing via Pull Requests

We greatly appreciate contributions in the form of pull requests (PRs). To make the review process as smooth as possible, please follow these steps:

1. Fork the repository: Start by forking the relevant Ultralytics repository (e.g., ultralytics/ultralytics) to your GitHub account.
2. Create a branch: Create a new branch in your forked repository with a clear, descriptive name reflecting your changes (e.g., fix-issue-123, add-feature-xyz).
3. Make your changes: Implement your improvements or fixes. Ensure your code adheres to the project's style guidelines and doesn't introduce new errors or warnings.
4. Test your changes: Before submitting, test your changes locally to confirm they work as expected and don't cause regressions. Add tests if you're introducing new functionality.
5. Commit your changes: Commit your changes with concise and descriptive commit messages. If your changes address a specific issue, include the issue number (e.g., Fix #123: Corrected calculation error.).
6. Create a pull request: Submit a pull request from your branch to the main branch of the original Ultralytics repository. Provide a clear title and a detailed description explaining the purpose and scope of your changes.

📝 CLA Signing

Before we can merge your pull request, you must sign our Contributor License Agreement (CLA). This legal agreement ensures that your contributions are properly licensed, allowing the project to continue being distributed under the AGPL-3.0 license.

After submitting your pull request, the CLA bot will guide you through the signing process. To sign the CLA, simply add a comment in your PR stating:

I have read the CLA Document and I sign the CLA

✍️ Google-Style Docstrings

When adding new functions or classes, include Google-style docstrings for clear, standardized documentation. Always enclose both input and output types in parentheses (e.g., (bool), (np.ndarray)).

!!! example "Example Docstrings"

=== "Google-style"

    This example illustrates the standard Google-style docstring format. Note how it clearly separates the function description, arguments, return value, and examples for maximum readability.

    ```python
    def example_function(arg1, arg2=4):
        """
        Example function demonstrating Google-style docstrings.

        Args:
            arg1 (int): The first argument.
            arg2 (int): The second argument.

        Returns:
            (bool): True if arguments are equal, False otherwise.

        Examples:
            >>> example_function(4, 4)  # True
            >>> example_function(1, 2)  # False
        """
        return arg1 == arg2
    ```

=== "Google-style named-returns"

    This example demonstrates how to document named return variables. Using named returns can make your code more self-documenting and easier to understand, especially for complex functions.

    ```python
    def example_function(arg1, arg2=4):
        """
        Example function demonstrating Google-style docstrings.

        Args:
            arg1 (int): The first argument.
            arg2 (int): The second argument.

        Returns:
            equals (bool): True if arguments are equal, False otherwise.

        Examples:
            >>> example_function(4, 4)  # True
        """
        equals = arg1 == arg2
        return equals
    ```

=== "Google-style multiple returns"

    This example shows how to document functions that return multiple values. Each return value should be documented separately with its own type and description for clarity.

    ```python
    def example_function(arg1, arg2=4):
        """
        Example function demonstrating Google-style docstrings.

        Args:
            arg1 (int): The first argument.
            arg2 (int): The second argument.

        Returns:
            equals (bool): True if arguments are equal, False otherwise.
            added (int): Sum of both input arguments.

        Examples:
            >>> equals, added = example_function(2, 2)  # True, 4
        """
        equals = arg1 == arg2
        added = arg1 + arg2
        return equals, added
    ```

    Note: Even though Python returns multiple values as a tuple (e.g., `return masks, scores`), always document each value separately for clarity and better tool integration. When documenting functions that return multiple values:

    ✅ Good - Document each return value separately:
    ```
    Returns:
       (np.ndarray): Predicted masks with shape HxWxN.
       (list): Confidence scores for each instance.
    ```

    ❌ Bad - Don't document as a tuple with nested elements:
    ```
    Returns:
       (tuple): Tuple containing:
           - (np.ndarray): Predicted masks with shape HxWxN.
           - (list): Confidence scores for each instance.
    ```

=== "Google-style with type hints"

    This example combines Google-style docstrings with Python type hints. When using type hints, you can omit the type information in the docstring arguments section, as it's already specified in the function signature.

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

        Args:
            arg1: The first argument.
            arg2: The second argument.

        Returns:
            True if arguments are equal, False otherwise.

        Examples:
            >>> example_function(1, 1)  # True
        """
        return arg1 == arg2
    ```

=== "Single-line"

    For smaller or simpler functions, a single-line docstring may be sufficient. These should be concise but complete sentences that start with a capital letter and end with a period.

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

✅ GitHub Actions CI Tests

All pull requests must pass the GitHub Actions Continuous Integration (CI) tests before they can be merged. These tests include linting, unit tests, and other checks to ensure that your changes meet the project's quality standards. Review the CI output and address any issues that arise.

✨ Best Practices for Code Contributions

When contributing code to Ultralytics projects, keep these best practices in mind:

• Avoid code duplication: Reuse existing code wherever possible and minimize unnecessary arguments.
• Make smaller, focused changes: Focus on targeted modifications rather than large-scale changes.
• Simplify when possible: Look for opportunities to simplify the code or remove unnecessary parts.
• Consider compatibility: Before making changes, consider whether they might break existing code using Ultralytics.
• Use consistent formatting: Tools like Ruff Formatter can help maintain stylistic consistency.
• Add appropriate tests: Include tests for new features to ensure they work as expected.

👀 Reviewing Pull Requests

Reviewing pull requests is another valuable way to contribute. When reviewing PRs:

• Check for unit tests: Verify that the PR includes tests for new features or changes.
• Review documentation updates: Ensure documentation is updated to reflect changes.
• Evaluate performance impact: Consider how changes might affect performance.
• Verify CI tests: Confirm all Continuous Integration tests are passing.
• Provide constructive feedback: Offer specific, clear feedback about any issues or concerns.
• Recognize effort: Acknowledge the author's work to maintain a positive collaborative atmosphere.

🐞 Reporting Bugs

We highly value bug reports as they help us improve the quality and reliability of our projects. When reporting a bug via GitHub Issues:

• Check existing issues: Search first to see if the bug has already been reported.
• Provide a Minimum Reproducible Example: Create a small, self-contained code snippet that consistently reproduces the issue. This is crucial for efficient debugging.
• Describe the environment: Specify your operating system, Python version, relevant library versions (e.g., torch, ultralytics), and hardware (CPU/GPU).
• Explain expected vs. actual behavior: Clearly state what you expected to happen and what actually occurred. Include any error messages or tracebacks.

📜 License

Ultralytics uses the GNU Affero General Public License v3.0 (AGPL-3.0) for its repositories. This license promotes openness, transparency, and collaborative improvement in software development. It ensures that all users have the freedom to use, modify, and share the software, fostering a strong community of collaboration and innovation.

We encourage all contributors to familiarize themselves with the terms of the AGPL-3.0 license to contribute effectively and ethically to the Ultralytics open-source community.

🌍 Open-Sourcing Your YOLO Project Under AGPL-3.0

Using Ultralytics YOLO models or code in your project? The AGPL-3.0 license requires that your entire derivative work also be open-sourced under AGPL-3.0. This ensures modifications and larger projects built upon open-source foundations remain open.

Why AGPL-3.0 Compliance Matters

• Keeps Software Open: Ensures that improvements and derivative works benefit the community.
• Legal Requirement: Using AGPL-3.0 licensed code binds your project to its terms.
• Fosters Collaboration: Encourages sharing and transparency.

If you prefer not to open-source your project, consider obtaining an Enterprise License.

How to Comply with AGPL-3.0

Complying means making the complete corresponding source code of your project publicly available under the AGPL-3.0 license.

1. Choose Your Starting Point:

   • Fork Ultralytics YOLO: Directly fork the Ultralytics YOLO repository if building closely upon it.
   • Use Ultralytics Template: Start with the Ultralytics template repository for a clean, modular setup integrating YOLO.

2. License Your Project:

   • Add an LICENSE file containing the full text of the AGPL-3.0 license.
   • Add a notice at the top of each source file indicating the license.

3. Publish Your Source Code:

   • Make your entire project's source code publicly accessible (e.g., on GitHub). This includes:
     • The complete larger application or system that incorporates the YOLO model or code.
     • Any modifications made to the original Ultralytics YOLO code.
     • Scripts for training, validation, inference.
     • Model weights if modified or fine-tuned.
     • Configuration files, environment setups (requirements.txt, Dockerfiles).
     • Backend and frontend code if it's part of a web application.
     • Any third-party libraries you've modified.
     • Training data if required to run/retrain and redistributable.

4. Document Clearly:

   • Update your README.md to state that the project is licensed under AGPL-3.0.
   • Include clear instructions on how to set up, build, and run your project from the source code.
   • Attribute Ultralytics YOLO appropriately, linking back to the original repository. Example:

     This project utilizes code from [Ultralytics YOLO](https://github.com/ultralytics/ultralytics), licensed under AGPL-3.0.
     

Example Repository Structure

Refer to the Ultralytics Template Repository for a practical example structure:

my-yolo-project/
│
├── LICENSE               # Full AGPL-3.0 license text
├── README.md             # Project description, setup, usage, license info & attribution
├── pyproject.toml        # Dependencies (or requirements.txt)
├── scripts/              # Training/inference scripts
│   └── train.py
├── src/                  # Your project's source code
│   ├── __init__.py
│   ├── data_loader.py
│   └── model_wrapper.py  # Code interacting with YOLO
├── tests/                # Unit/integration tests
├── configs/              # YAML/JSON config files
├── docker/               # Dockerfiles, if used
│   └── Dockerfile
└── .github/              # GitHub specific files (e.g., workflows for CI)
    └── workflows/
        └── ci.yml

By following these guidelines, you ensure compliance with AGPL-3.0, supporting the open-source ecosystem that enables powerful tools like Ultralytics YOLO.

🎉 Conclusion

Thank you for your interest in contributing to Ultralytics open-source YOLO projects. Your participation is essential in shaping the future of our software and building a vibrant community of innovation and collaboration. Whether you're enhancing code, reporting bugs, or suggesting new features, your contributions are invaluable.

We're excited to see your ideas come to life and appreciate your commitment to advancing object detection technology. Together, let's continue to grow and innovate in this exciting open-source journey. Happy coding! 🚀🌟

FAQ

Why should I contribute to Ultralytics YOLO open-source repositories?

Contributing to Ultralytics YOLO open-source repositories improves the software, making it more robust and feature-rich for the entire community. Contributions can include code enhancements, bug fixes, documentation improvements, and new feature implementations. Additionally, contributing allows you to collaborate with other skilled developers and experts in the field, enhancing your own skills and reputation. For details on how to get started, refer to the Contributing via Pull Requests section.

How do I sign the Contributor License Agreement (CLA) for Ultralytics YOLO?

To sign the Contributor License Agreement (CLA), follow the instructions provided by the CLA bot after submitting your pull request. This process ensures that your contributions are properly licensed under the AGPL-3.0 license, maintaining the legal integrity of the open-source project. Add a comment in your pull request stating:

I have read the CLA Document and I sign the CLA

For more information, see the CLA Signing section.

What are Google-style docstrings, and why are they required for Ultralytics YOLO contributions?

Google-style docstrings provide clear, concise documentation for functions and classes, improving code readability and maintainability. These docstrings outline the function's purpose, arguments, and return values with specific formatting rules. When contributing to Ultralytics YOLO, following Google-style docstrings ensures that your additions are well-documented and easily understood. For examples and guidelines, visit the Google-Style Docstrings section.

How can I ensure my changes pass the GitHub Actions CI tests?

Before your pull request can be merged, it must pass all GitHub Actions Continuous Integration (CI) tests. These tests include linting, unit tests, and other checks to ensure the code meets the project's quality standards. Review the CI output and fix any issues. For detailed information on the CI process and troubleshooting tips, see the GitHub Actions CI Tests section.

How do I report a bug in Ultralytics YOLO repositories?

To report a bug, provide a clear and concise Minimum Reproducible Example along with your bug report. This helps developers quickly identify and fix the issue. Ensure your example is minimal yet sufficient to replicate the problem. For more detailed steps on reporting bugs, refer to the Reporting Bugs section.

What does the AGPL-3.0 license mean if I use Ultralytics YOLO in my own project?

If you use Ultralytics YOLO code or models (licensed under AGPL-3.0) in your project, the AGPL-3.0 license requires that your entire project (the derivative work) must also be licensed under AGPL-3.0 and its complete source code must be made publicly available. This ensures that the open-source nature of the software is preserved throughout its derivatives. If you cannot meet these requirements, you need to obtain an Enterprise License. See the Open-Sourcing Your Project section for details.