Cómo contribuir¶
¡Las contribuciones son bienvenidas y muy agradecidas! Todo ayuda y siempre vas a recibir
¡Las contribuciones son bienvenidas y son muy apreciadas! Cada ayuda un poco, y siempre se dará crédito.
Puedes contribuir de muchas maneras:
Tipos de contribuciones¶
Reportar bugs o errores¶
Reportalos en https://github.com/tacosdedatos/tacosdedatos-utils/issues.
Si estas reportando un bug, porfa íncluye:
El nombre y versión de tu sistema operativo.
Cualquier detalle sobre su configuración local que pueda ser útil en solución de problemas.
Pasos detallados para reproducir el error.
Corregir bugs o errores¶
Puedes revistar los issues en GitHub (tacosdedatos/tacosdedatos-utils). Cualquiera con la etiqute «bug» y «ayuda pls» esta abierto a quien quiera implementar la solución.
Implementar Features o funciones¶
Puedes revistar los issues en GitHub (tacosdedatos/tacosdedatos-utils). Cualquiera con la etiqute «mejora» y «ayuda pls» esta abierto a quien quiera implementar la solución.
Escribir documenteishon¶
tacosdedatos-utils
siempre puede utilizar más documentación. Ya sea en
los docs oficiales, en docstrings, o en la web con publicaciónes en blogs, artículos y mucho más.
Enviar comentarios¶
La mejor manera de proveer retroalimentación es crear un issue en https://github.com/tacosdedatos/tacosdedatos-utils/issues.
Si estás proponiendo una mejora:
Explica en detallo como va a funcionar.
Mantén el enfoque/alcance lo más estrecho posible para que sea más fácil implementar.
Recuerde que este es un proyecto impulsado por voluntarixs, y que las contribuciones son bienvenidas :)
¡Comencemos!¶
¿Listx para contribuir? Aquí esta como configurar tacosdedatos-utils para desarrollo local.
Crea un fork del repositorio en GitHub [tacosdedatos-utils]{#tacosdedatos-utils}.
Clona tu fork localmente:
$ git clone https://github.com/tu_cuenta_de_github/tacosdedatos-utils.git
Instala tu copia local en un entorno virtual. Con
tacosdedatos-utils
utilizamospoetry
Asumiendo que lo tengas instalado, así es como configurars tu fork para desarrollo local:$ cd tacosdedatos-utils/ $ make install $ poetry shell # para activar tu entorno virtual
Si no tienes instalado poetry
Ejecuta el comando
make download-poetry
Crea una branch para el desarrollo local:
$ git checkout -b nombre-de-tu-mejora-o-correccion
Ahora puedes hacer cambios locales.
Cuando termines de hacer tus cambios, asegurate que tus cambios pasen los tests, el estilo de código y las medidas de seguridad que utilizamos en
tacosdedatos-utils
esto es fácil de hacer con los siguientes comando:$ make codestyle $ make tests $ make check-safety
Haz commit tus cambios y publicalos en tu branch de GitHub:
$ git add . $ git commit -m "Descripción detallada de tu mejora o arreglo de bug" $ git push origin nombre-de-tu-mejora-o-correccion
Envía una pull request a través de GitHub.
Directríces de las Pull Request¶
Antes de enviar una pull request, verifica que cumpla lo siguiente:
La pull request debe incluir tests.
Si tu pull request agrega funcionalidad, la documentación debe ser actualizada. Agrega tu nueva funcionalidad en una función con una docstring, y agrega tu mejora en la lista en el
README.md
.La pull request debería funcionar en Python 3.6+
Publicación¶
Un recordatorio para quienes mantienen el paquete. Asegurate que todos tus cambios esten
cometidos (incluyendo una entrada a sobre-tacosdedatos-utils/historia.md
).
Luego ejecuta:
$ poetry version patch # opciones: major / minor / patch
$ git tag -a <LA-NUEVA-VERSION-DEL-PAQUETE> -m "Versión <LA-NUEVA-VERSION-DEL-PAQUETE>"
$ git push && git push --tags
El paquete será publicado a PyPI a través de GitHub Actions