Como colaborar¶

Toda ayuda es bien recibida, pero hay que seguir unas normas por el bien del proyecto. Antes incluso de que leas más sobre el proyecto, es importante que sepas como colaborar. Este es un proyecto software, donde sus contribudores están deslocalizados.

Requisitos¶

Los requisitos para trabajar son tener instalado:

Python 3.8
Gestor de paquetes pip
Paquete pipenv

Metodología¶

La metodología de trabajo es la siguiente:

Haz un fork del repositorio en tu cuenta de Github.
Cambia a la rama dev y trabaja sobre ella.
Info

Te recomendamos que añadas también el repo oficial en el remote de git, para que puedas tener los cambios del repositorio oficial en tu local.
```
git remote add oficial https://github.com/Respyrator/respirador
```
Mira los issues del proyecto así como el tablero de tareas.
Antes de hacer avances por tu cuenta, mira si puedes desarrollar algún issue que ya esté abierto.

Tip

Es más importante ir cerrando issues, que tener muchas abiertas.
Para cualquier desarrollo que quieras hacer: abre primero un issue, ponle las etiquetas correspondientes y justifícalo.
Los desarrollos o cambios que hagas en el programa y que necesiten explicación, ponlo en la documentación.

Warning

Si no documentas, estas dificultando la labor de tus compañer@s presentes y futuros.
Con ese comportamiento estás haciendo más daño que bien al proyecto.
Haz tests unitarios de todos tus cambios / mejoras y comprueba que pasas tanto los tuyos como los que ya hay.
Failure

Para los tests se está usando la suite Pytest.
Ejecutando el siguiente comando se ejecutan todos los tests
```
pipenv run test
```
Esto no es un proyecto de juguete, la vida de personas van a depender de él.
Tu código debe de pasar todos los tests ya hechos, y tu debes de preocuparte de hacer tests exhaustivos para tus mejoras.
Si no mantenemos esto, a parte de entorpecer a tus compañer@s, podrían perderse vidas humanas.
Comprueba en tu servidor local que la documentación haya quedado bien (para más información, ve a la sección de la documentación)
Una vez has pasados los tests y la documentación esté bien, guarda los cambios en commits atómicos.

Info

Esto quiere decir que para cada mejora hagas debe de ir en un pequeño commit que pueda ser revisable luego.
Los commits con muchos ficheros y cambios distintos dificultan el trabajo.
Comprueba que tengas tu rama dev actualizada respecto a la del repo oficial
Danger

Si no haces esto, puedes generar conflictos entre ficheros, con su correspondiente carga de trabajo extra.
Descarga primero los cambios de la rama dev a tu repo local con
```
git pull oficial dev
```
Ahora haz lo siguiente:
1. Resuelve conflictos en los ficheros si los hubiere.
2. Vuelve a pasar los tests.
3. Comprueba la documentación.
4. Si está todo OK, ya puedes seguir
Sube los cambios a tu repo, siempre en la rama dev.
Haz un pull request desde tu rama dev a la rama dev.
Los pull requests deben de pasar los tests automatizados del sistema de CI configurado.
Una vez pasen los tests, los administradores los revisarán y los aceptarán.