Cómo colaborar en este proyecto

En qué ayudar

Revisa la lista de issues, escoge algo te te llame la atención, como corregir algún bug, crear una nueva funcionalidad o documentar.

Empezando

Si es la primera vez, clona el repositorio:

1. Haz un fork del repositorio a tu cuenta en github

2. Clona a tu PC o laptop el repositorio de tu cuenta

   git clone [email protected]:tucuenta/admin-cfdi.git

Reanudando

Si ya tienes un repositorio local en el que has estado trabajando antes, pon la rama develop al día con el repositorio en LinuxCabal, donde podrían haber cambios que se hayan aceptado de otros colaboradores:

 git remote add lc https://github.com/LinuxCabal/admin-cfdi.git
 git pull lc develop

Lineamientos para el código

1. Revisa que el código nuevo cumpla con PEP8

2. Crea pruebas unitarias antes de refactorizar. Lee Testing Your Code para aprender.

Haciendo y enviando cambios

Ahora sí, a trabajar:

1. Crea una rama a partir de la rama develop:

git checkout -b tema develop

tema podrá ser un nombre que indica qué vas a trabajar, por ejemplo: mejorar-reportes o corregir-indice-incorrecto, etc.

1. procura que el diff de cada commit pueda ser entendido por los demás. Si hay más de algún cambio, haz un commit para cada uno.
2. Prueba tus cambios
3. Cuando estén listos, empuja tu rama hacia tu repositorio:

git push origin tema

1. Desde github, haz clic en el botón Create Pull Request, selecciona develop como la rama destino en el repositorio en LinuxCabal, incluye una breve descripción del para qué o porqué de tu solicitud.

Lineamientos para la documentación

1. Incluye una docstring en funciones o métodos nuevos que se agreguen, puede ser de una línea indicando el valor que se regresa o qué hace la función o método

Documentación

Necesitas instalar Sphinx, ya sea en un ambiente virtual si lo usas:

pip install Sphinx

o en tu distro con un comando así en Debian/Ubuntu por ejemplo:

apt-get python3-sphinx

La documentación del proyecto está en la carpeta docs, consta de varios archivos .rst en StructuredText. Para una introducción, lee reStructuredText Primer, es muy fácil aprenderlo.

Para construir la documentación:

sphinx-build -b html docs /ruta_destino

Otras áreas para ayudar

• Si te gusta diseñar, puedes trabajar en la interfaz gráfica de la aplicación, dentro de la carpeta IMG puedes ver las imágenes usadas.
• Si eres contador o administrador, puedes ayudarnos con tus ideas para mejorar la herramienta.
• Si eres entusiaste del software libre, puedes ayudarnos a probar la herramienta en diferentes entornos y a difundirla.
• Si tienes dudas de cualquier tema mencionado, no te preocupes, ponte en contacto con cualquier miembro de la comunidad, con gusto te ayudaremos.