Si tienes alguna sugerencia de funcionalidades o reporte de errores, puedes ayudarnos revisando los issues del proyecto, si no se está trabajando en ello entonces abre un issue nuevo:
El repositorio tiene la siguiente estructura, sígala para contribuir:
battle-sim
|- doc
| |_ (aquí la documentación)
|- src
| |_ (aquí los códigos fuentes del proyecto)
|- test
| |_ (aquí los casos de prueba)
|- LICENSE
|- README.md
|_
Se tendrán dos ramas principales:
maindonde estará una versión estable del proyecto donde todas las componentes hayan pasado los casos de prueba.devdonde se irán mezclando las ramas resultantes de nuevas funcionalidades, corrección de errores y ramas personales. Luego de que en esta rama todo funcione bien y pase los casos de prueba entonces se mezcla haciamain.
Abre una nueva rama a partir de dev con el siguiente nombre features/<funcionalidad> y ahí implementa la funcionalidad, realiza los casos de prueba y haz un pull request para revisar entre todos los cambios, para posteriormente aprobar los cambios.
Abre una nueva rama con el siguiente nombre bug/<error>, corrige el error, corre los casos de prueba, y haz el pull request correspondiente. Para posteriormente mezclar.
Usted debe siempre que arregle un error o añada nuevas funcionalidades agregar casos de prueba utilizando la librería pytest y el plugin pytest-cov para verificar cuanto de su código está probando con sus casos de prueba. Antes de hacer un pull request todo su código debe pasar los casos de prueba con un coverage mayor a 90%, y no introducir que fallen los casos de prueba de otras funcionalidades.
Sus casos de prueba deben ir en la carpeta test. Para ejecutar los casos de pruba ejecute los comandos siguientes:
pytest test
pytest --cov
El primer comando ejecutará todos los comandos en la carpeta test y calculará el coverage de los casos de prueba.