Contribuir a Ultralytics Repositorios de c贸digo abierto YOLO
Gracias por su inter茅s en contribuir a la Ultralytics C贸digo abierto YOLO 隆Repositorios! Sus contribuciones mejorar谩n el proyecto y beneficiar谩n a toda la comunidad. Este documento proporciona pautas y pr谩cticas recomendadas para ayudarlo a comenzar.
脥ndice
C贸digo de conducta
Todos los colaboradores deben adherirse al C贸digo de Conducta para garantizar un entorno acogedor e inclusivo para todos.
Contribuir mediante Pull Requests
Damos la bienvenida a las contribuciones en forma de solicitudes de extracci贸n. Para agilizar el proceso de revisi贸n, siga estas pautas:
-
Fork del repositorio: Bifurca el repositorio Ultralytics YOLO en tu cuenta de GitHub.
-
Crear una rama: Crea una nueva rama en tu repositorio bifurcado con un nombre descriptivo para tus cambios.
-
Haz tus cambios: Aseg煤rate de que tus cambios siguen el estilo de codificaci贸n del proyecto y no introducen nuevos errores o advertencias.
-
Prueba tus cambios: Prueba tus cambios localmente para asegurarte de que funcionan como esperas y no introducen nuevos problemas.
-
Confirma tus cambios: Confirma tus cambios con un mensaje de confirmaci贸n descriptivo. Incluye cualquier n煤mero de incidencia relevante en tu mensaje de confirmaci贸n.
-
Crear un pull request: Crea un pull request desde tu repositorio bifurcado al repositorio principal Ultralytics YOLO . 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, debes firmar un Acuerdo de Licencia de Colaborador (CLA). Este documento legal 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:
Google-Estilo Docstrings
Cuando a帽adas nuevas funciones o clases, incluye un docstring al estilo de Google para proporcionar documentaci贸n clara y concisa a otros desarrolladores. Esto ayuda a garantizar que tus contribuciones sean f谩ciles de entender y mantener.
Ejemplo de Docstrings
Este ejemplo muestra un docstring del estilo Google. Observa que tanto la entrada como la salida types debe estar 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 sobre los argumentos y el tipo de retorno, aunque ambas no son necesarias; se puede utilizar una 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 simples pueden utilizar una cadena de documentos de una sola l铆nea. Tenga en cuenta que la cadena de documentos debe usar 3 comillas dobles y ser una oraci贸n completa que comience con una letra may煤scula y termine con un punto.
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. Revisa el resultado de las Acciones de GitHub y soluciona 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.
Esperamos ver sus ideas en acci贸n y apreciamos su compromiso con el avance de la tecnolog铆a de detecci贸n de objetos. Sigamos creciendo e innovando juntos en este emocionante viaje de c贸digo abierto. 隆Feliz codificaci贸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 ayuda a mejorar 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 ofrece la oportunidad de colaborar con otros desarrolladores cualificados y expertos en la materia, potenciando tus propias habilidades y reputaci贸n. Para m谩s informaci贸n 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. Esto garantizar谩 que tus contribuciones se licencien correctamente bajo la licencia AGPL-3.0 , manteniendo la integridad legal del proyecto de c贸digo abierto. A帽ade un comentario en tu pull request mencionando:
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, los argumentos y los valores de retorno con reglas de formato espec铆ficas. Cuando contribuyas a Ultralytics YOLO , seguir el estilo de los docstrings de Google garantiza que tus aportaciones sean comprensibles y est茅n bien documentadas. 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 se fusione tu pull request, 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 los est谩ndares de calidad del proyecto. Revisa el resultado de las Acciones de GitHub y soluciona cualquier problema. Para obtener informaci贸n detallada sobre el proceso de IC y consejos para solucionar problemas, consulta la secci贸n Pruebas de IC 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.