Saltar al contenido

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
  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.

Ejemplo de Docstrings

Este ejemplo muestra un docstring al estilo Google. Observa que tanto la entrada como la salida types debe ir siempre entre par茅ntesis, es decir (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

Este ejemplo muestra tanto una docstring al estilo Google como sugerencias de argumentos y tipos de retorno, aunque ambas no son necesarias, una puede utilizarse sin la otra.

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

Las funciones m谩s peque帽as o sencillas pueden utilizar una docstring de una sola l铆nea. Ten en cuenta que la docstring debe utilizar 3 comillas dobles y ser una frase completa que empiece con may煤scula y termine con punto.

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! 馃殌馃専



Creado 2023-11-12, Actualizado 2024-05-18
Autores: glenn-jocher (5)

Comentarios