colabora es una aplicación web para escribir, revisar y aprobar los resúmenes de iniciativas.
-
Copia este repositorio a tu cuenta en GitHub (Crea un fork)
-
Clona de tu repositorio a tu computadora, se crea el remote
origin
:git clone git@github.com:<tu-usuario>/colabora.git
-
Agrega un remote
upstream
:git remote add upstream https://github.com/siguealcongreso/colabora.git
-
Configura git para hacer pull de
main
enupstream
y siempre hacer push aorigin
:git config --local branch.main.remote upstream git remote set-url --push upstream git@github.com:<tu-usuario>/colabora.git
-
Crea un entorno virtual
python3 -m venv env
-
Activa el entorno virtual
. env/bin/activate
-
Instala la aplicación con sus dependencias en modo de desarrollo
pip install -e '.[test]'
-
Corre las pruebas
pytest --cov=colabora
-
Inicializa la base de datos
flask --app colabora.main shell >> from colabora.db import init_db >> init_db() >> exit()
-
Corre la aplicación
flask --debug --app colabora.main run
-
Visita http://localhost:5000
-
Actualiza la rama
main
de tu repositorio local con los cambios más recientes del repositorio original:git checkout main git pull upstream
-
Crea una nueva rama en donde van a ir los cambios en los que trabajes.
git checkout -b issue-48 main
-
Haz modificaciones
-
Activa el entorno virtual
. env/bin/activate
-
Corre la aplicación
flask --debug --app colabora.main run
-
Visita http://localhost:5000 para revisar las modficaciones
-
Corre las pruebas
pytest --cov=colabora
-
Revisa que tus modificaciones cumplen con los Requerimientos para los commits que se describen en la siguiente sección.
-
Realiza uno o más commits en tu computadora
-
Empuja la rama con tus modificaciones a tu repositorio en GitHub
-
Solicita que se incluyan tus cambios (Crea un Pull Request)
-
Una vez que se aprobó el Pull Request, borra la rama del issue:
git branch -d issue-48 git push -d origin issue-48
-
Revisa que
git diff --check
no reporte renglones con espacios al final en los archivos que modificas. -
Modifica solamente los renglones necesarios para resolver el issue en cuestión. No hagas cambios cosméticos en otros renglones del código que no tienen que ver con lo que estás mejorando.
-
Si estás agregando texto, revisa que cumple con la Ortografía y Gramática.
-
Activa el entorno virtual
. env/bin/activate
-
Instala la dependencia para la documentación
pip install -e '.[doc]'
-
Genera la documentación
cd docs make html
-
Navega a
build/html/index.html