Skip to content

Latest commit

 

History

History
127 lines (92 loc) · 4.2 KB

CONTRIBUTING.md

File metadata and controls

127 lines (92 loc) · 4.2 KB

Contribuir a SIMPLE

Damos las gracias y bienvenidas sean todas las correcciones y mejoras en el desarrollo del código de SIMPLE, pruebas y documentación. Esta guía detalla como contribuir en el proyecto de una manera que sea eficiente para toda la comunidad.

  1. Prerequisitos
  2. Preparación de ambiente local
  3. Detección y solución de issues
  1. Agregar nuevas características
  2. Actualizar mi repositorio local
  3. ¿Dudas, consultas, información?

1. Prerequisitos

1.1 Leer el Manual de SIMPLE

1.2 Tener clara la normalización de código fuente

1.3 Documentar y comentarizar correcciones y/o nuevos desarrollos.

Volver

2. Preparación de ambiente local

2.1 Realizar Fork del repositorio https://github.com/e-gob/SIMPLE a tu cuenta GitHub

2.2 Clonar el proyecto forkeado desde tu cuenta GitHub. Ejemplo:

https://github.com/nombreusuario/SIMPLE.git

2.3 Agregar el repositorio padre como origen remoto. Ejemplo:

git remote add upstream https://github.com/e-gob/SIMPLE.git

2.4 Luego de clonado el proyecto, crear la rama beta para empezar a trabajar. Ejemplo:

git checkout -b beta

2.5 Realizar los commits con una descripción sobre la o las nuevas funcionalidades

git commit -m “ Modifico funcionalidad manager”

2.6 Generar un push hacia la rama beta del proyecto forkeado. Ejemplo:

git push origin beta

2.7 Generar un pull request hacia la rama beta del proyecto origen por la interfaz de Github

Volver

3. Detección y solución de issues

3.1 Detección de issues

Antes de ingresar la incidencia, se recomienda buscar dentro del tracker de issues entradas similares para verificar que la incidencia ya haya sido reportada o resuelta.

Para ingresar un issue, favor usar la siguiente plantilla en el área de descripción:

3.1.1 Resumen (Resumir el issue en una sentencia. Cual es el error o que esperas que suceda)

3.1.2 Pasos para reproducir (Como se reproduce el issue)

3.1.3 Comportamiento esperado (Lo que debe ver en su lugar)

3.1.4 En lo posible, capturas de pantalla relevantes (Capturas de pantalla que ayuden a reproducir el error)

Volver

3.2 Solución de issues

Lo principal es primero cumplir con los prerequisitos, luego :

3.2.1 Comentar el Issue y detallar la solución que se entregará.

3.2.2 Realizar los commits con una descripción sobre la o las correcciones realizadas"

git commit -m "Modifico funcionalidad manager"

3.2.3 Generar un push hacia la rama beta del proyecto forkeado. Ejemplo:

git push origin beta

3.2.4 Generar un pull request hacia la rama beta del proyecto origen por la interfaz de Github

Volver

4. Agregar nuevas características

Para agregar nuevas caracteristicas, es necesario primero cumplir con los prerequisitos

4.1 Abrir un ISSUE, indicando cual es la caracteristica, funcionalidad o complemento que falta en SIMPLE

4.2 Comentar el Issue, agregar la solución que se entregara.

4.3 Realizar los commits con una descripción sobre la o las nuevas funcionalidades:

git commit -m "Modifico funcionalidad manager"

4.4 Generar un push hacia la rama beta del proyecto forkeado. Ejemplo:

git push origin beta

4.5 Generar un pull request hacia la rama beta del proyecto origen por la interfaz de Github

Volver

5. Actualizar mi repositorio local

Si queremos actualizar nuestro repositorio con los cambios del repositorio padre SIMPLE debemos seguir los siguientes pasos

git fetch upstream

git merge upstream/master

Donde master indica la rama del repositorio padre a actualizar

Volver

6. ¿Dudas, consultas, información?

contáctese con nosotros al correo simple@minsegpres.gob.cl

Volver