Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

24 lines (18 loc) · 2.54 KB

Contribuir

Si gustaría contribuir al proyecto, realice un Fork y haga sus cambios sugeridos. Una vez esté satisfecho con el resultado, vuelva a la página del proyecto en GitHub y redacte un Pull Request de su Fork para la rama 'main'. Tenga en cuenta el siguiente procedimiento.

En su computador debe tener un ambiente virtual de Python con los siguientes paquetes y sus dependencias. Recomendamos Python 3.7 con Miniconda o pipenv. Si su sistema operativo es Windows, siga las instrucciones en este enlace para trabajar con Jupyter Book.

Recomendamos también usar GitHub Desktop para hacer el manejo de versiones de su Fork.

  • Una vez tenga en su cuenta de GitHub el Fork del proyecto, clonelo a su computador.
  • Edite los archivos que considere prudentes (Tenga en cuenta la documentación de Jupyter Book).
  • Desde la terminal, active su ambiente virtual de Python y dirijase al directorio donde clonó su proyecto ($ cd path/to/../Github/optimizacion).
  • El siguiente comando construirá la página estática a partir de los archivos en el directorio:jb build optimizacion (si está en Windows, revise las instrucciones mencionadas anteriormente de la documentación).
  • Dirijase al directorio en '_build/html' dentro del proyecto y abra en su explorador web el archivo 'index.html'.
  • Verifique que no se haya roto ningún aspecto del libro y que se vean reflejados sus cambios.
  • Si hay errores o tiene cambios pendientes, realice sus cambios y vuelva a construir el libro para validarlos.
  • Haga commit y push de sus cambios a su repositorio.
  • Tenga en cuenta que, al hacer un Fork, puede también crear una página propia de 'GitHub Pages' que podrá actualizar automáticamente según el contenido actualizado de su rama 'main' (Vea '.github/workflows').
  • Ahora, desde el repositorio origen del proyecto en GitHub, realice el pull request de su Fork a la rama 'main' del repositorio origen, desde la rama de SU Fork con los últimos cambios. Comente en buen detalle y de forma concisa sus cambios.
  • Es responsabilidad de cada quien aliviar los conflictos de su PR.

Algún dueño del proyecto evaluará su PR y, según vea apropiado, aceptará, rechazará o sugerirá cambios.