Contribuir

¡Las contribuciones son bienvenidas y muy apreciadas! Cada pequeña ayuda cuenta, y siempre se dará crédito.

Puedes contribuir de muchas maneras:

Tipos de Contribuciones

Reportar Errores

Reporta errores en https://github.com/ragnarok22/cryptobot_python/issues.

Si estás reportando un error, por favor incluye:

El nombre y versión de tu sistema operativo.
Cualquier detalle sobre tu configuración local que pueda ser útil para solucionar el problema.
Pasos detallados para reproducir el error.

Corregir Errores

Revisa los issues de GitHub en busca de errores. Cualquier cosa etiquetada con «bug» y «help wanted» está abierta para quien quiera implementarla.

Implementar Funcionalidades

Revisa los issues de GitHub en busca de funcionalidades. Cualquier cosa etiquetada con «enhancement» y «help wanted» está abierta para quien quiera implementarla.

Escribir Documentación

CryptoBot Python siempre puede beneficiarse de más documentación, ya sea como parte de la documentación oficial de CryptoBot Python, en docstrings, o incluso en la web en posts de blog, artículos y similares.

Traducir Documentación

¡Ayuda a hacer CryptoBot Python accesible para personas que no hablan inglés contribuyendo traducciones! Consulta la Guía de Traducción en la documentación para una guía completa sobre cómo traducir la documentación a otros idiomas.

Enviar Retroalimentación

La mejor manera de enviar retroalimentación es crear un issue en https://github.com/ragnarok22/cryptobot_python/issues.

Si estás proponiendo una funcionalidad:

Explica en detalle cómo funcionaría.
Mantén el alcance lo más acotado posible, para facilitar la implementación.
Recuerda que este es un proyecto impulsado por voluntarios, y que las contribuciones son bienvenidas :)

¡Comienza!

¿Listo para contribuir? Aquí te mostramos cómo configurar cryptobot_python para el desarrollo local.

Haz un fork del repositorio cryptobot_python en GitHub.

Clona tu fork localmente:

$ git clone git@github.com:your_name_here/cryptobot_python.git

Instala tu copia local con uv. Así es como configuras tu fork para el desarrollo local:
```
$ cd cryptobot_python/
$ uv sync
```
Crea una rama para el desarrollo local:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Ahora puedes hacer tus cambios localmente.
Cuando hayas terminado de hacer cambios, verifica que tus cambios pasen flake8 y las pruebas:
```
$ make lint
$ make test
```
Para ejecutar pruebas de integración (se requiere red + token de API):
```
$ pytest --run-integration tests/test_sync_client.py
```

Haz commit de tus cambios y sube tu rama a GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Envía un pull request a través del sitio web de GitHub.

Guías para Pull Requests

Antes de enviar un pull request, verifica que cumpla con estas guías:

El pull request debe incluir pruebas.
Si el pull request añade funcionalidad, la documentación debe ser actualizada. Coloca tu nueva funcionalidad en una función con un docstring, y añade la funcionalidad a la lista en README.md.
El pull request debe funcionar para Python 3.10, 3.11, 3.12, 3.13 y 3.14. Revisa el workflow de GitHub Actions y asegúrate de que las pruebas pasen para todas las versiones de Python soportadas.

Consejos

Para ejecutar un subconjunto de pruebas:

$ pytest tests/test_specific.py

Despliegue

Un recordatorio para los mantenedores sobre cómo desplegar. Asegúrate de que todos tus cambios estén confirmados (incluyendo una entrada en HISTORY.md). Luego ejecuta:

::

GitHub Actions luego desplegará a PyPI si las pruebas pasan.