Consejos para empezar a contribuir a los proyectos de código abierto de Ultralytics

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 forma estupenda de unir a las personas para crear algo más grande que ellas mismas. En Ultralytics, tenemos muy presentes los principios del código abierto y siempre te animamos a contribuir a nuestros proyectos de código abierto.

Si te entusiasma contribuir, ya sea escribiendo documentación, revisando código o resolviendo problemas, pero no tienes claro por dónde empezar o te encuentras con algunos problemas, estamos aquí para ayudarte a dar tus primeros pasos. En este artículo, te ofrecemos algunos consejos para empezar a contribuir a los proyectos de código abierto de Ultralytics. ¡Vamos allá!

La importancia de las contribuciones de la comunidad de Ultralytics#

Antes de ver cómo contribuir, respondamos a la pregunta de por qué las contribuciones son tan importantes. Creemos firmemente en la importancia de las contribuciones de la comunidad de Ultralytics. Al participar en nuestros proyectos de código abierto, haces mucho más que ayudarnos a crear un software mejor. Las personas contribuidoras desempeñan un papel fundamental para garantizar que nuestra tecnología siga siendo abierta, colaborativa y evolucione constantemente. ¡Tus contribuciones mantienen nuestros proyectos activos, accesibles y útiles para usuarios y desarrolladores de todo el mundo!

Además de crear software puntero, contribuir a los proyectos de Ultralytics también es una oportunidad fantástica para crecer. Puedes desarrollar tus habilidades de programación, resolución de problemas y trabajo en equipo mientras colaboras con desarrolladores experimentados que pueden ofrecerte orientación y compartir buenas prácticas. Tus esfuerzos pueden tener un impacto real en herramientas utilizadas por miles de personas en todo el mundo. Participar en nuestra comunidad también puede ayudarte a ampliar tu red profesional, abrirte nuevas oportunidades y mejorar tu portafolio para destacar ante posibles empleadores.

Fig. 1. Motivos para contribuir. Imagen del autor.

Cómo empezar a contribuir a los proyectos de código abierto de Ultralytics#

Un buen punto de partida es consultar la guía oficial de contribución de Ultralytics. Incluye buenas prácticas y consejos para que aproveches al máximo tus contribuciones. El primer paso sería familiarizarte con lo que ya forma parte del proyecto: comprende las directrices de contribución y sumérgete en el código.

Tanto si quieres contribuir al desarrollo como si simplemente quieres explorar el código más reciente, el siguiente paso es clonar el repositorio de Ultralytics. Después, puedes acceder al directorio del proyecto e instalar el paquete en modo editable, como se muestra en el fragmento de código siguiente.

Si necesitas ayuda, nuestra guía de inicio rápido contiene todo lo que necesitas para empezar sin problemas.

Distintas áreas en las que puedes contribuir#

Una vez que hayas configurado tu entorno y te hayas familiarizado con el proyecto, puedes explorar las distintas áreas en las que puedes generar un impacto significativo. Ultralytics ofrece varias formas de participar, y puedes elegir cómo contribuir según tus habilidades e intereses.

Estas son algunas de las opciones:

• Documentación: Contribuir a la documentación es una forma estupenda de adentrarte en el proyecto mientras perfeccionas tus habilidades de redacción. Puedes ayudar mejorando la documentación existente, añadiendo detalles que falten o creando nuevas guías que faciliten la contribución de otras personas.
• Corrección de errores: Si tienes experiencia programando, puedes trabajar en la corrección de errores. Estos pueden ir desde pequeños ajustes hasta problemas más complejos, lo que te brinda la oportunidad de generar un impacto tangible en el proyecto.
• Mejoras de funcionalidades: Si estás preparado para profundizar, trabajar en mejoras de funcionalidades puede ser todo un reto y resultar muy gratificante. Esto puede implicar añadir funcionalidades nuevas, mejorar las existentes o trabajar en la hoja de ruta del proyecto.
• Revisión de pull requests: Revisar pull requests es otra forma valiosa de contribuir, especialmente si conoces los estándares y las buenas prácticas del proyecto. Al proporcionar comentarios y sugerir mejoras, ayudas a mantener la calidad y la integridad del código base.
• Debates de la comunidad: Participar en los debates de la comunidad es una forma excelente de contribuir si te gusta colaborar e intercambiar ideas. Participa en las conversaciones en curso, propón ideas nuevas o ayuda a otras personas ofreciendo tus conocimientos y soluciones.

Cada una de estas áreas ofrece una forma única de contribuir, y puedes elegir la que mejor se adapte a tus puntos fuertes e intereses. Recuerda que toda contribución, por pequeña que sea, desempeña un papel fundamental para ayudar a Ultralytics a crecer y evolucionar.

Fig. 2. Todas las contribuciones son valiosas en nuestra comunidad en crecimiento. Fuente de la imagen: Envato Elements.

Contribuir a la documentación de código abierto de Ultralytics#

Cuando contribuyas a la documentación de Ultralytics, asegúrate de revisar la documentación existente y comprobar si hay problemas o debates que señalen áreas que necesitan mejoras. De este modo, te asegurarás de centrar tus contribuciones allí donde más se necesitan.

Al escribir o editar, ten en cuenta que es fundamental seguir las directrices del proyecto para mantener la coherencia. Estos son algunos consejos de formato:

• Usa siempre el formato Markdown.
• Empieza cada documento con una introducción clara y utiliza un lenguaje sencillo y accesible.
• Usa listas con viñetas, texto descriptivo para los enlaces e imágenes de menos de 1 MB para que las páginas se carguen rápidamente.
• Si tienes dudas sobre el formato, una forma sencilla de comprobarlo es revisar cómo se ha dado formato a la documentación anterior.

Fig. 3. Un ejemplo de formato Markdown (a la izquierda) y del documento visualizado final (a la derecha). Imagen del autor.

Cuando hayas preparado el borrador, es importante previsualizarlo compilando la documentación localmente. Así podrás detectar cualquier problema antes de enviarlo. Para hacerlo, empieza clonando el repositorio y accediendo al directorio del proyecto:

A continuación, instala las dependencias necesarias:

Por último, sirve la documentación localmente para revisar los cambios:

Puedes ver la documentación compilada localmente accediendo a http://127.0.0.1:8000/ en tu navegador web.

Después de revisar la claridad, precisión y coherencia, puedes enviar un pull request con una descripción clara del documento que has creado. Asegúrate de colocar el documento en la sección adecuada según dónde corresponda y encaje mejor (guías, soluciones, integraciones, etc.). Revisa también el archivo index.md para consultar las secciones pertinentes y el archivo mkdocs.yml general, y realiza las actualizaciones necesarias. Prestar atención a los detalles ayudará a que el proceso de revisión transcurra sin problemas y garantizará que tu contribución se integre correctamente en el proyecto.

Aspectos que debes tener en cuenta al contribuir a código de código abierto#

Al contribuir con código al proyecto de Ultralytics, es importante seguir buenas prácticas que ayuden a garantizar que tu código sea limpio, fácil de mantener y sencillo de integrar. Estos son algunos puntos clave que debes tener en cuenta:

• Evita duplicar código: Reutiliza el código existente siempre que sea posible y minimiza los argumentos innecesarios.
• Haz cambios pequeños y específicos: Céntrate en cambios pequeños y concretos en lugar de realizar modificaciones de gran alcance.
• Simplifica o elimina código: Busca oportunidades para simplificar el código o eliminar partes innecesarias.
• Escribe docstrings eficaces: Explica claramente qué hace tu código y enlaza a recursos pertinentes.
• Evita dependencias innecesarias: Añade dependencias solo si son absolutamente necesarias.

Fig. 4. Buenas prácticas de documentación del código fuente.

También es fundamental tener en cuenta la facilidad de mantenimiento del código base a largo plazo. Antes de realizar cualquier cambio, pregúntate si tus modificaciones podrían romper el código existente de alguien que utilice Ultralytics. Si es así, piensa cómo abordar esta situación y asegúrate de que tus cambios sean lo más compatibles posible.

Cuando hayas desarrollado un fragmento de código para contribuir, tendrás que probarlo. Puedes usar frameworks como pytest para probar tus cambios antes de enviarlos. Mantener un formato de código coherente es otro aspecto muy importante de tu contribución. Herramientas como Ruff Formatter pueden ayudarte a mantener la coherencia de estilo y detectar errores lógicos o incoherencias en tu código.

Revisión de pull requests#

¡Revisar pull requests (PRs) es una forma estupenda de contribuir! Se crea un PR cuando alguien solicita fusionar sus cambios con el proyecto principal. Esto ayuda a que el proyecto de Ultralytics funcione sin problemas. Cuando revises un PR, asegúrate de entender por qué se han realizado los cambios. El autor debe explicar claramente el propósito y las ventajas de la actualización, y en su PR deberías encontrar pruebas de que se han realizado pruebas exhaustivas.

Fig. 5. ¿Qué es un pull request?

Veamos algunos aspectos clave en los que debes centrarte.

• Comprueba las pruebas unitarias: Comprueba que el PR incluye pruebas para las funcionalidades nuevas o los cambios, con el fin de confirmar que el código funciona como se espera y no introduce problemas.
• Revisa las actualizaciones de la documentación: Verifica que la documentación se ha actualizado para reflejar los cambios o las funcionalidades nuevas, incluidos los ejemplos, las referencias de API y otros detalles pertinentes.
• Evalúa el impacto en el rendimiento: Considera cómo afectan los cambios al rendimiento. Si es necesario, solicita benchmarks de rendimiento o pruebas adicionales.
• Verifica las pruebas de CI: Asegúrate de que todas las pruebas de Integración continua (CI) se superan correctamente, incluidas las comprobaciones del formato del código y los resultados de las pruebas unitarias.
• Colabora en las correcciones: Si falla alguna prueba, trabaja con el autor para resolver los problemas antes de aprobar el PR.

Como persona revisora, asegúrate de proporcionar comentarios específicos y claros sobre cualquier problema o preocupación. Ofrece sugerencias de mejora y haz preguntas que ayuden al autor a analizar posibles problemas. Anímale a seguir buenas prácticas de programación, pruebas y documentación, y no dudes en indicarle recursos que puedan serle útiles. Por último, reconoce siempre el esfuerzo que el autor ha dedicado al PR. Los comentarios positivos ayudan a mantener un ambiente cordial y colaborativo en la comunidad de código abierto.

Contribuir es una cuestión de comunidad#

Contribuir a proyectos de código abierto como Ultralytics puede proporcionarte una inspiradora sensación de comunidad. Tanto si escribes código, revisas PRs, actualizas documentación o participas en debates, todos los esfuerzos ayudan al proyecto a crecer y evolucionar. Responder a problemas o participar en conversaciones, ya sea en GitHub, Discord, Subreddit u otros foros, es una forma valiosa de contribuir y conectar con otras personas. Recuerda que tus contribuciones, por pequeñas que sean, tienen un impacto significativo y ayudan a fomentar un entorno colaborativo y de apoyo para todas las personas implicadas.

En Ultralytics, nos apasiona impulsar la innovación en la comunidad de código abierto. Mantente al día de nuestras últimas novedades visitando nuestro repositorio de GitHub. Únete a nuestra vibrante comunidad y descubre cómo estamos generando un impacto en sectores como la agricultura y la fabricación.