Herramientas para establecer lineamientos de contribución

Una pequeña investigación de algunas herramientas que ayudan a contribuir en repositorios públicos.

hace 3 meses   •   2 min de lectura

Por Andrés Tuñón

Al trabajar en repositorios open-source en github, debes definir lineamientos de contribución y esto implica cómo se crean los pull requests, se reportan los issues e incluso el orden del código.

Github y sus complementos

Github te provee de ciertos complementos que ayudan a personalizar tu repositorio:

  • Puedes crear un ejemplo o placeholder de cómo realizar un issue bajo tus condiciones.
Ejemplo de cómo crear un issue en chakra ui
Ejemplo de cómo crear un issue en chakra ui
  • Puedes guiar al nuevo contribuyente.
Ejemplo de markdown de contribución
Ejemplo de markdown de contribución

Herramientas generales

Hay algunas herramientas que encontré en el repositorio de chakra ui que me parecieron interesantes y me gustaría implementar en un futuro próximo:

Preconstruct

Ayuda a ejecutar comandos y controlar de mejor forma los procesos de desarrollo en un monorepositorio.

Changesets

Ayuda a administrar el versionamiento y cambios (changelogs) dentro de un repositorio con multiples paquetes.

Husky

Esto ayuda a agregar hooks para git y mejorar los commits bajo el mismo proyecto, ejecutando comandos y más.

Commit Conventions

Chakra UI sigue una convención de commits que me pareció muy acertado para darle seguimiento a los cambios y registrarlos en los releases.

Y bueno este es un pequeño acercamiento e investigación de todo lo que debo hacer en un futuro.

Aún me falta aprender de los labels, ejecutar pruebas eficientes, que te permitan previsualizar los cambios de un Pull Request y mucho más. Todo esto lo vi con Chakra UI y su monorepositorio.

Referencias

Aquí dejo las recomendaciones oficiales de Github:

Setting guidelines for repository contributors - GitHub Docs
You can create guidelines to communicate how people should contribute to your project.

Y aquí dejo de donde obtuve los ejemplos, fue la primera vez que lo conocí:

GitHub - chakra-ui/chakra-ui: ⚡️ Simple, Modular & Accessible UI Components for your React Applications
⚡️ Simple, Modular & Accessible UI Components for your React Applications - GitHub - chakra-ui/chakra-ui: ⚡️ Simple, Modular & Accessible UI Components for your React Applications

Corre la voz

Sigue leyendo