Contribuir a Ultralytics Repositorios de código abierto YOLO

En primer lugar, ¡gracias por tu interés en contribuir a los repositorios de código abierto YOLO de Ultralytics ! Tus contribuciones ayudarán a mejorar el proyecto y beneficiarán a la comunidad. Este documento proporciona directrices y buenas prácticas para empezar.

Índice

1. Código de conducta
2. Contribuir mediante Pull Requests
   • Firma del CLA
   • Docstrings estilo Google
   • Acciones de GitHub Pruebas CI
3. Informar de errores
4. Licencia
5. Conclusión

Código de conducta

Se espera que todos los colaboradores se adhieran al Código de Conducta para garantizar un entorno acogedor e inclusivo para todos.

Contribuir mediante Pull Requests

Agradecemos las contribuciones en forma de pull requests. Para facilitar el proceso de revisión, sigue estas directrices:

1. Fork del repositorio: Abre el repositorio Ultralytics YOLO en tu propia cuenta de GitHub.

2. Crear una rama: Crea una nueva rama en tu repositorio bifurcado con un nombre descriptivo para tus cambios.

3. Haz tus cambios: Haz los cambios con los que quieras contribuir. Asegúrate de que tus cambios siguen el estilo de codificación del proyecto y no introducen nuevos errores o advertencias.

4. Prueba tus cambios: Prueba tus cambios localmente para asegurarte de que funcionan como esperas y no introducen nuevos problemas.

5. Confirma tus cambios: Confirma tus cambios con un mensaje de confirmación descriptivo. Asegúrate de incluir cualquier número de incidencia relevante en tu mensaje de confirmación.

6. Crear un pull request: Crea un pull request desde tu repositorio bifurcado al repositorio principal Ultralytics YOLO . En la descripción del pull request, proporciona una explicación clara de tus cambios y de cómo mejoran el proyecto.

Firma del CLA

Antes de que podamos aceptar tu pull request, tienes que firmar un Acuerdo de Licencia de Colaborador (CLA). Se trata de un documento legal que declara que aceptas las condiciones para contribuir a los repositorios de Ultralytics YOLO . El CLA garantiza que tus contribuciones están debidamente licenciadas y que el proyecto puede seguir distribuyéndose bajo la licencia AGPL-3.0 .

Para firmar el CLA, sigue las instrucciones proporcionadas por el bot del CLA después de enviar tu RP y añade un comentario en tu RP diciendo:

I have read the CLA Document and I sign the CLA

Docstrings estilo Google

Cuando añadas nuevas funciones o clases, incluye un docstring al estilo Google para proporcionar documentación clara y concisa a otros desarrolladores. Esto ayudará a garantizar que tus contribuciones sean fáciles de entender y mantener.

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

Acciones de GitHub Pruebas CI

Antes de que tu pull request pueda fusionarse, deben superarse todas las pruebas de Integración Continua (IC) de las Acciones de GitHub. Estas pruebas incluyen linting, pruebas unitarias y otras comprobaciones para asegurar que tus cambios cumplen los estándares de calidad del proyecto. Asegúrate de revisar el resultado de las Acciones de GitHub y solucionar cualquier problema

Informar de errores

Agradecemos los informes de errores, ya que desempeñan un papel crucial en el mantenimiento de la calidad del proyecto. Al informar de errores, es importante proporcionar un Ejemplo Mínimo Reproducible: un ejemplo de código claro y conciso que reproduzca el problema. Esto ayuda a identificar y resolver rápidamente el fallo.

Licencia

Ultralytics adopta la Licencia Pública General Affero GNU v3.0 (AGPL-3.0 ) para sus repositorios, promoviendo la apertura, la transparencia y la mejora colaborativa en el desarrollo de software. Esta sólida licencia con copyleft garantiza que todos los usuarios y desarrolladores conserven la libertad de utilizar, modificar y compartir el software. Fomenta la colaboración de la comunidad, garantizando que cualquier mejora siga siendo accesible para todos.

Se anima a los usuarios y desarrolladores a que se familiaricen con las condiciones de AGPL-3.0 para contribuir de forma eficaz y ética a la comunidad de código abierto de Ultralytics .

Conclusión

Gracias por tu interés en contribuir a los proyectos de código abierto deUltralytics YOLO . Tu participación es crucial para dar forma al futuro de nuestro software y fomentar una comunidad de innovación y colaboración. Ya sea mejorando el código, informando de errores o sugiriendo funciones, tus contribuciones tienen un impacto significativo.

Estamos ansiosos por ver tus ideas en acción y apreciamos tu compromiso con el avance de la tecnología de detección de objetos. Sigamos creciendo e innovando juntos en este apasionante viaje de código abierto. ¡Feliz programación! 🚀🌟

Comentarios