Al hacer clic en "Aceptar todas las cookies", usted acepta el almacenamiento de cookies en su dispositivo para mejorar la navegación por el sitio, analizar el uso del sitio y ayudar en nuestros esfuerzos de marketing. Más información en
Configuración de cookies
Al hacer clic en "Aceptar todas las cookies", usted acepta el almacenamiento de cookies en su dispositivo para mejorar la navegación por el sitio, analizar el uso del sitio y ayudar en nuestros esfuerzos de marketing. Más información en
Aprenda a contribuir a los proyectos de código abierto de Ultralytics y explore los mejores consejos relacionados con la documentación, la revisión de PR y el uso de herramientas esenciales.
La base del software de código abierto es la colaboración, el aprendizaje y el intercambio. Los proyectos de código abierto son una excelente manera de que las personas se unan para construir algo más grande que ellas mismas. En Ultralytics, llevamos los principios del código abierto en el corazón y siempre le animamos a contribuir a nuestros proyectos de código abierto.
Si tiene ganas de contribuir, ya sea escribiendo documentación, revisando código o resolviendo problemas, pero no está seguro de por dónde empezar o se enfrenta a algunos problemas, estamos aquí para ayudarle a empezar. En este artículo, le daremos algunos consejos para empezar a contribuir a los proyectos de código abierto de Ultralytics. Entremos de lleno.
La importancia de las contribuciones de la comunidad Ultralytics
Antes de echar un vistazo a cómo contribuir, respondamos a la pregunta de por qué las contribuciones son tan cruciales. Creemos firmemente en la importancia de las contribuciones de la comunidad Ultralytics. Al participar en nuestros proyectos de código abierto, usted hace algo más que ayudarnos a construir un software mejor. Los colaboradores desempeñan un papel clave para garantizar que nuestra tecnología siga siendo abierta, colaborativa y en constante evolución. Sus contribuciones hacen que nuestros proyectos sigan siendo prósperos, accesibles y beneficiosos para usuarios y desarrolladores de todo el mundo.
Más allá de crear software de vanguardia, contribuir a los proyectos de Ultralytics es también una fantástica oportunidad para crecer. Puedes desarrollar tus habilidades de codificación, resolución de problemas y trabajo en equipo mientras trabajas junto a desarrolladores experimentados que pueden ofrecerte orientación y compartir las mejores prácticas. Sus esfuerzos pueden tener un impacto real en las herramientas utilizadas por miles de personas en todo el mundo. Participar en nuestra comunidad también puede ayudarte a ampliar tu red profesional, abrir nuevas oportunidades y mejorar tu cartera para que destaques ante los empleadores.
Fig. 1. Razones para contribuir. Imagen del autor.
Cómo empezar con las contribuciones de código abierto de Ultralytics
Un buen punto de partida es consultar la guía oficial de contribuciones de Ultralytics. Está repleta de buenas prácticas y consejos que le ayudarán a sacar el máximo partido de sus contribuciones. El primer paso sería familiarizarse con lo que ya forma parte del proyecto mediante la comprensión de las directrices de contribución y la inmersión en el código.
Tanto si quieres contribuir al desarrollo como si sólo quieres explorar el código más reciente, el siguiente paso es clonar el repositorio de Ultralytics. Una vez hecho esto, puedes ir al directorio del proyecto e instalar el paquete en modo editable, como se muestra en el siguiente fragmento de código.
Una vez que haya configurado su entorno y esté familiarizado con el proyecto, puede explorar las diferentes áreas en las que puede tener un impacto significativo. Ultralytics ofrece varias formas de participar, y puedes elegir cómo contribuir en función de tus habilidades e intereses.
He aquí algunas de las opciones:
Documentación: Contribuir a la documentación es una buena manera de sumergirse en el proyecto mientras perfeccionas tus habilidades de escritura. Puedes ayudar mejorando la documentación existente, añadiendo detalles que faltan o creando nuevas guías que faciliten la contribución de otros.
Corrección de errores: Si tienes experiencia en programación, considera la posibilidad de trabajar en la corrección de errores. Pueden ser desde pequeños ajustes hasta problemas más complejos, lo que te dará la oportunidad de tener un impacto tangible en el proyecto.
Mejoras: Para quienes estén dispuestos a profundizar, trabajar en la mejora de funciones puede ser un reto a la vez que gratificante. Esto puede implicar añadir nuevas funciones, mejorar las existentes o trabajar en la hoja de ruta del proyecto.
Pull request reviews: Revisar pull requests es otra forma valiosa de contribuir, especialmente si estás familiarizado con los estándares y las mejores prácticas del proyecto. Al proporcionar comentarios y sugerir mejoras, ayudas a mantener la calidad y la integridad del código base.
Debates comunitarios: Participar en los debates de la comunidad es una forma excelente de contribuir si te gusta colaborar y compartir ideas. Participe en las conversaciones en curso, proponga nuevas ideas o ayude a los demás ofreciéndoles sus ideas y soluciones.
Cada una de estas áreas ofrece una forma única de contribuir, y usted puede elegir la que mejor se alinee con sus fortalezas e intereses. Recuerde, cada contribución, por pequeña que sea, desempeña un papel clave para ayudar a Ultralytics a crecer y evolucionar.
Fig. 2. Toda contribución es valorada en nuestra creciente comunidad. Fuente de la imagen: Envato Elements.
Contribución a la documentación de código abierto de Ultralytics
Cuando contribuya a la documentación de Ultralytics, asegúrese de revisar la documentación existente y comprobar si hay problemas o discusiones que destaquen áreas que necesiten mejoras. De este modo, se asegurará de que sus contribuciones se centran donde más se necesitan.
Cuando escriba o edite, tenga en cuenta que es fundamental seguir las directrices del proyecto para mantener la coherencia. Aquí tienes algunos consejos de formato:
Empiece cada documento con una introducción clara y mantenga un lenguaje sencillo y accesible.
Utilice viñetas en las listas, texto descriptivo en los enlaces e imágenes de menos de 1 MB para que las páginas se carguen rápidamente.
Si tiene dudas sobre el formato, una forma fácil de comprobarlo es ver cómo se ha formateado la documentación anterior.
Fig. 3. Un ejemplo de formato Markdown (a la izquierda) y el documento final visualizado (a la derecha). Imagen del autor.
Una vez elaborado el borrador, es importante previsualizarlo creando la documentación localmente. Así podrás detectar cualquier problema antes de enviarla. Para ello, clona el repositorio y navega hasta el directorio del proyecto:
A continuación, puede instalar las dependencias necesarias:
Por último, sirva la documentación localmente para revisar sus cambios:
Puede consultar los documentos creados localmente accediendo a `http://127.0.0.1:8000/` en su navegador web.
Después de revisar la claridad, precisión y coherencia, puede enviar una solicitud de extracción con una descripción clara del documento que ha creado. Asegúrate de colocar el documento en la sección adecuada según el lugar al que pertenezca y en el que encaje mejor(guías, soluciones, integraciones, etc.). Echa también un vistazo al archivo index.md para las secciones pertinentes y al archivo general mkdocs.yml, y realiza las actualizaciones necesarias. Prestar atención a los detalles ayudará a que el proceso de revisión se desarrolle sin problemas y garantizará que su contribución se integre bien en el proyecto.
Aspectos a tener en cuenta al contribuir a open-sourcecCode
Al contribuir con código al proyecto Ultralytics, es importante seguir las mejores prácticas para garantizar que el código sea limpio, fácil de mantener y de integrar. Estos son algunos puntos clave a tener en cuenta:
Evite la duplicación de código: Reutiliza el código existente siempre que sea posible y minimiza los argumentos innecesarios.
Realice cambios más pequeños y específicos: Céntrese en cambios más pequeños y específicos en lugar de grandes modificaciones.
Simplificar o eliminar código: Busca oportunidades para simplificar el código o eliminar partes innecesarias.
Escribir docstrings: Explica claramente qué hace tu código y enlaza con los recursos pertinentes.
Evite las dependencias innecesarias: Añade dependencias sólo si son absolutamente necesarias.
Fig. 4. Mejores prácticas de documentación del código fuente.
También es esencial tener en cuenta la mantenibilidad a largo plazo del código base. Antes de realizar cualquier cambio, pregúntese si sus modificaciones podrían romper el código existente de alguien que utilice Ultralytics. Si es así, piense en cómo solucionarlo y asegúrese de que sus cambios sean lo más compatibles posible.
Una vez que hayas desarrollado un fragmento de código para contribuir, tendrás que probarlo. Puedes utilizar frameworks como pytest para probar tus cambios antes de enviarlos. El formato coherente del código es otro aspecto muy importante de tu contribución. Herramientas como Ruff Formatter pueden ayudarte a mantener la coherencia estilística y a detectar cualquier error lógico o incoherencia en tu código.
Revisión de pull requests
Revisar pull requests (PRs) es una buena forma de contribuir. Un PR se genera cuando alguien solicita fusionar sus cambios en el proyecto principal. Ayuda a mantener el proyecto Ultralytics funcionando sin problemas. Cuando revises un PR, asegúrate de que entiendes por qué se han hecho los cambios. El autor debe explicar claramente el propósito y los beneficios de la actualización, y usted debe ver evidencia de pruebas exhaustivas en su PR.
Repasemos algunos aspectos clave en los que centrarnos.
Comprobación de las pruebas unitarias: Comprueba que el PR incluye pruebas para las nuevas funciones o cambios para confirmar que el código funciona como se espera y no introduce problemas.
Revise las actualizaciones de la documentación: Compruebe que la documentación está actualizada para reflejar los cambios o las nuevas funciones, incluidos ejemplos, referencias de API y otros detalles relevantes.
Evalúe el impacto en el rendimiento: Considera cómo afectan los cambios al rendimiento. Si es necesario, solicita referencias de rendimiento o pruebas adicionales.
Verificar las pruebas CI: Asegúrese de que se superan todas las pruebas de integración continua (CI ), incluidas las comprobaciones del formato del código y los resultados de las pruebas unitarias.
Colabore en las correcciones: Si alguna prueba falla, trabaja con el autor para resolver los problemas antes de aprobar el PR.
Como revisor, asegúrese de proporcionar comentarios específicos y claros sobre cualquier problema o preocupación. Ofrezca sugerencias de mejora y formule preguntas que ayuden al autor a reflexionar sobre posibles problemas. Anímele a seguir las mejores prácticas de codificación, pruebas y documentación, y no dude en indicarle recursos que puedan ayudarle. Por último, pero no por ello menos importante, reconozca siempre el esfuerzo que el autor ha dedicado al RP. Los comentarios positivos ayudan a mantener un ambiente amistoso y de colaboración en la comunidad de código abierto.
Contribuir es una cuestión de comunidad
Contribuir a proyectos de código abierto como Ultralytics puede darle un inspirador sentido de comunidad. Ya sea escribiendo código, revisando relaciones públicas, actualizando documentación o participando en debates, cada esfuerzo ayuda a que el proyecto crezca y evolucione. Responder a cuestiones o participar en conversaciones, ya sea en GitHub, Discord, Subreddit u otros foros, es una forma valiosa de contribuir y conectar con los demás. Recuerda que tus contribuciones, por pequeñas que sean, tienen un impacto significativo y ayudan a fomentar un entorno de colaboración y apoyo para todos los implicados.
En Ultralytics, nos apasiona impulsar la innovación en la comunidad de código abierto. Manténgase al día de nuestros últimos desarrollos visitando nuestro repositorio de GitHub. Únase a nuestra vibrante comunidad y vea cómo estamos influyendo en sectores como la agricultura y la fabricación.