Contribuir a los proyectos de código abierto de Ultralytics

¡Bienvenido/a! Estamos encantados de que te plantees contribuir a nuestros Ultralytics proyectos de código abierto. Tu participación no sólo ayuda a mejorar la calidad de nuestros repositorios, sino que también beneficia a toda la comunidad. Esta guía proporciona directrices claras y buenas prácticas para ayudarte a empezar.

Código de conducta

Para garantizar un entorno acogedor e integrador para todos, todos los colaboradores deben cumplir nuestro Código de Conducta. El respeto, la amabilidad y la profesionalidad están en el corazón de nuestra comunidad.

Contribuir mediante Pull Requests

Agradecemos enormemente las contribuciones en forma de pull requests. Para que el proceso de revisión sea lo más fluido posible, sigue estos pasos:

Bifurca el repositorio: Comienza bifurcando el repositorio Ultralytics YOLO en tu cuenta de GitHub.
Crea una rama: Crea una nueva rama en tu repositorio bifurcado con un nombre claro y descriptivo que refleje tus cambios.
Haz tus cambios: Asegúrate de que tu código se ajusta a las directrices de estilo del proyecto y no introduce nuevos errores o advertencias.
Prueba tus cambios: Antes de enviarlos, prueba tus cambios localmente para confirmar que funcionan como se espera y que no causan nuevos problemas.
Confirma tus cambios: Confirma tus cambios con un mensaje de confirmación conciso y descriptivo. Si tus cambios se refieren a un problema concreto, incluye el número del problema en tu mensaje de confirmación.
Crea un pull request: Envía un pull request desde tu repositorio bifurcado al repositorio principal de Ultralytics YOLO . Proporciona una explicación clara y detallada de tus cambios y de cómo mejoran el proyecto.

Firma del CLA

Antes de que podamos fusionar tu pull request, debes firmar nuestro Acuerdo de Licencia de Colaborador (CLA). Este acuerdo legal garantiza que tus contribuciones están debidamente licenciadas, permitiendo que el proyecto siga distribuyéndose bajo la licencia AGPL-3.0 .

Tras enviar tu pull request, el bot CLA te guiará a través del proceso de firma. Para firmar el CLA, simplemente añade un comentario en tu PR indicando:

I have read the CLA Document and I sign the CLA

Google-Estilo Docstrings

Cuando añadas nuevas funciones o clases, incluye docstrings al estilo de Google. Estos docstrings proporcionan una documentación clara y estandarizada que ayuda a otros desarrolladores a entender y mantener tu código.

Ejemplo de Docstrings

Google-estiloGoogle-estilo con sugerencias de tipoUna sola línea

Este ejemplo ilustra un docstring del estilo Google. Asegúrate de que tanto la entrada como la salida types siempre van entre paréntesis, por ejemplo (bool).

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

    Args:
        arg1 (int): The first argument.
        arg2 (int): The second argument, with a default value of 4.

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

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

Este ejemplo incluye tanto un docstring al estilo Google como sugerencias de tipo para los argumentos y los retornos, aunque también es aceptable utilizar cualquiera de los dos de forma independiente.

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

    Args:
        arg1: The first argument.
        arg2: The second argument, with a default value of 4.

    Returns:
        True if successful, False otherwise.

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

Para funciones más pequeñas o sencillas, puede bastar con una docstring de una sola línea. La docstring debe utilizar tres comillas dobles, ser una frase completa, empezar con mayúscula y terminar con un punto.

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

Acciones de GitHub Pruebas CI

Todas las pull requests deben superar las pruebas de Integración Continua (IC) de las Acciones de GitHub antes de que puedan fusionarse. Estas pruebas incluyen linting, pruebas unitarias y otras comprobaciones para asegurar que tus cambios cumplen los estándares de calidad del proyecto. Revisa el resultado de la integración continua y soluciona cualquier problema que surja.

Informar de errores

Valoramos mucho los informes de errores, ya que nos ayudan a mantener la calidad de nuestros proyectos. Cuando informes de un fallo, proporciona un Ejemplo Mínimo Reproducible: unejemplo de código sencillo y claro que reproduzca el problema de forma coherente. Esto nos permite identificar y resolver rápidamente el problema.

Licencia

Ultralytics utiliza la Licencia Pública General Affero GNU v3.0 (AGPL-3.0 ) para sus repositorios. Esta licencia promueve la apertura, la transparencia y la mejora colaborativa en el desarrollo de software. Garantiza que todos los usuarios tengan libertad para utilizar, modificar y compartir el software, fomentando una sólida comunidad de colaboración e innovación.

Animamos a todos los colaboradores a familiarizarse con los términos de la licencia AGPL-3.0 para contribuir de forma eficaz y ética a la comunidad de código abierto Ultralytics .

Conclusión

Gracias por tu interés en contribuir a Ultralytics los proyectos de código abierto de YOLO . Tu participación es esencial para dar forma al futuro de nuestro software y construir una vibrante comunidad de innovación y colaboración. Ya sea mejorando el código, informando de errores o sugiriendo nuevas funciones, tus contribuciones son inestimables.

Nos entusiasma ver cómo tus ideas cobran vida y apreciamos tu compromiso con el avance de la tecnología de detección de objetos. Juntos, sigamos creciendo e innovando en este apasionante viaje de código abierto. ¡Feliz programación! 🚀🌟

PREGUNTAS FRECUENTES

¿Por qué debería contribuir a los repositorios de código abierto de Ultralytics YOLO ?

Contribuir a los repositorios de código abierto de Ultralytics YOLO mejora el software, haciéndolo más robusto y rico en funciones para toda la comunidad. Las contribuciones pueden incluir mejoras del código, correcciones de errores, mejoras de la documentación e implementaciones de nuevas funciones. Además, contribuir te permite colaborar con otros desarrolladores cualificados y expertos en la materia, mejorando tus propias habilidades y reputación. Para más detalles sobre cómo empezar, consulta la sección Contribuir mediante Pull Requests.

¿Cómo firmo el Acuerdo de Licencia de Contribuidor (CLA) para Ultralytics YOLO ?

Para firmar el Acuerdo de Licencia de Contribuidor (CLA), sigue las instrucciones proporcionadas por el bot CLA después de enviar tu pull request. Este proceso garantiza que tus contribuciones están debidamente licenciadas bajo la licencia AGPL-3.0 , manteniendo la integridad legal del proyecto de código abierto. Añade un comentario en tu pull request indicando:

I have read the CLA Document and I sign the CLA.

Para más información, consulta la sección Firma CLA.

¿Qué son los docstrings de estilo Google y por qué son necesarios para las contribuciones a Ultralytics YOLO ?

Google-proporcionan una documentación clara y concisa de las funciones y clases, mejorando la legibilidad y el mantenimiento del código. Estas docstrings describen el propósito de la función, sus argumentos y valores de retorno con reglas de formato específicas. Cuando contribuyas a Ultralytics YOLO , seguir los docstrings del estilo de Google garantiza que tus aportaciones estén bien documentadas y se entiendan fácilmente. Para ver ejemplos y directrices, visita la sección Google-Style Docstrings.

¿Cómo puedo asegurarme de que mis cambios superan las pruebas de GitHub Actions CI?

Antes de que tu pull request pueda fusionarse, debe superar 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 el código cumple

las normas de calidad del proyecto. Revisa la salida de CI y soluciona cualquier problema. Para obtener información detallada sobre el proceso de CI y consejos para solucionar problemas, consulta la sección Pruebas de CI de las acciones de GitHub.

¿Cómo informo de un error en los repositorios de Ultralytics YOLO ?

Para informar de un fallo, proporciona un Ejemplo Mínimo Reproducible claro y conciso junto con tu informe de fallo. Esto ayuda a los desarrolladores a identificar y solucionar rápidamente el problema. Asegúrate de que tu ejemplo es mínimo pero suficiente para reproducir el problema. Para pasos más detallados sobre cómo informar de fallos, consulta la sección Informar de fallos.

📅 Created 10 months ago ✏️ Updated 4 days ago