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/latam/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/latam). 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/latam). Cualquiera con la etiqute «mejora» y «ayuda pls» esta abierto a quien quiera implementar la solución.

Escribir documenteishon

latam 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/latam/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 latam para desarrollo local.

  1. Crea un fork del repositorio en GitHub [latam]{#latam}.

  2. Clona tu fork localmente:

    $ git clone https://github.com/tu_cuenta_de_github/latam.git
    
  3. Instala tu copia local en un entorno virtual. Con latam utilizamos poetry Asumiendo que lo tengas instalado, así es como configurars tu fork para desarrollo local:

    $ cd latam/
    $ make install
    $ poetry shell # para activar tu entorno virtual 
    

    Si no tienes instalado poetry

    Ejecuta el comando make download-poetry

  4. Crea una branch para el desarrollo local:

    $ git checkout -b nombre-de-tu-mejora-o-correccion
    

    Ahora puedes hacer cambios locales.

  5. 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 latam esto es fácil de hacer con los siguientes comando:

    $ make codestyle
    $ make tests
    $ make check-safety
    
  6. 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
    
  7. 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:

  1. La pull request debe incluir tests.

  2. 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.

  3. La pull request debería funcionar en Python 3.6+

Tips

Para ejecutar los tests

$ make tests

Publicación

Un recordatorio para quienes mantienen el paquete. Asegurate que todos tus cambios esten cometidos (incluyendo una entrada a sobre-latam/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