Vai al contenuto

Contribuire ai repository open-source 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.

Indice dei contenuti

  1. Codice di condotta
  2. Contribuire con le richieste di pull
  3. Segnalazione di bug
  4. Licenza
  5. Conclusione

Codice di condotta

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

Contribuire con le richieste di pull

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. Crea un ramo: Crea un nuovo ramo nel tuo repository con un nome descrittivo per le tue modifiche.

  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.

Firma del CLA

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.

Per firmare il CLA, segui le istruzioni fornite dal bot CLA dopo aver inviato la tua PR e aggiungi un commento nella tua PR dicendo:

I have read the CLA Document and I sign the CLA

Docstring in stile 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.

Esempi di documentazione

Questo esempio mostra una docstring in stile Google. Nota che sia l'input che l'output 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

Azioni GitHub Test 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.

Segnalazione di bug

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.

Licenza

Ultralytics abbraccia la GNU Affero General Public License v3.0 (AGPL-3.0 ) per i suoi repository, promuovendo l'apertura, la trasparenza e il miglioramento collaborativo nello sviluppo del software. Questa forte licenza copyleft garantisce a tutti gli utenti e agli sviluppatori la libertà di utilizzare, modificare e condividere il software. Favorisce la collaborazione della comunità, assicurando che qualsiasi miglioramento rimanga accessibile a tutti.

Gli utenti e gli sviluppatori sono invitati a familiarizzare con i termini di AGPL-3.0 per contribuire in modo efficace ed etico alla comunità open-source di Ultralytics .

Conclusione

YOLO Grazie per il tuo interesse a contribuire ai progetti open-source diUltralytics . La tua partecipazione è fondamentale per dare forma al futuro del nostro software e per promuovere una comunità di innovazione e collaborazione. Che tu stia migliorando il codice, segnalando bug o suggerendo funzionalità, i tuoi contributi hanno un impatto significativo.

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)

Commenti