Skip to content

Commit 62e3508

Browse files
committed
Clarify documentation and fix markdown issues
1 parent 9019a1c commit 62e3508

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
title: Lineamientos de desarrollo
22
logo: /assets/img/logo.png
3-
description: Lineamientos para del desarrollo de aplicaciones sobre el repositorio de la Dirección de Información y Tecnologías DSIT de la Universidad de Los Andes. Versión 1.1.1
3+
description: Lineamientos para del desarrollo de aplicaciones sobre el repositorio de la Dirección de Información y Tecnologías DSIT de la Universidad de Los Andes. Versión 1.1.2
44
show_downloads: false
55
google_analytics:
66
theme: jekyll-theme-minimal

style/COMMITS_DOCUMENTATION.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Los lineamientos de estilo son los siguientes:
2626
* :arrow_up: `:arrow_up:` cuando actualice dependencias
2727
* :arrow_down: `:arrow_down:` cuando desactualice dependencias
2828
* :shirt: `:shirt:` cuando elimine advertencias del linter
29-
* Continue por el código de la historia de usuario o issue al cual está aportando el desarrollo. El formato es de la forma <HU/IS>-<ID FASE PROYECTO>-<NÚMERO HISTORIA> Por ejemplo:
29+
* Continue por el código de la historia de usuario o issue al cual está aportando el desarrollo. El formato es de la forma `<HU/IS>-<ID FASE PROYECTO>-<NÚMERO HISTORIA>` Por ejemplo:
3030
* HU-S1-001
3131
* Haga uso del _present tense_ (_"Add feature"_, no _"Added feature"_)
3232
* Haga uso del _imperative mood_ (_"Move cursor to..."_, no _"Moves cursor to..."_)
@@ -56,8 +56,12 @@ Todo código en este repositorio debe ser documentado a dos niveles.
5656
* Refiérase a los métodos de clase con `{ClassName.methodName}`
5757
* Use la wiki para documentar todo aquello adicional que otros desarrolladores deben saber del desarrollo para poder ejecutarlo y continuar con el.
5858

59-
Si se considera necesario, la documentación autogenerada de código (dependiendo el framework) puede ser presentada en el repositorio. Para esto usted debe solicitar la aprobación de dejar pública la documentación, si se considera necesario usted debe:
59+
Si se considera necesario, la documentación autogenerada de código (dependiendo el framework) puede ser presentada en el repositorio, para esto usted debe:
6060

61-
* Crear una rama que tendrá solo la documentación. Esta rama debe ser protegida para que no sea mezclada con las demás.
61+
* Crear una rama que tendrá solo la documentación. Esta rama debe ser protegida para que no sea mezclada con las demás.
62+
* Agregar en la wiki el link a la rama en la cual se encuentra la documentación.
63+
64+
En caso que se considere dejar pública la documentación. Se debe solicitar la aprobación del CedEx que gestiona el repositorio de código, si la DSIT considera que es viable su publicación usted debe:
65+
6266
* Crear una página web haciendo uso de la característica de github para este fin, y apuntando a la rama de documentación.
63-
* Seleccione la plantilla y modifíquela para que integre la documentación autogenerada o los archivos .md que usted requiera para documentar su código.
67+
* Seleccione la plantilla y modifíquela para que integre la documentación autogenerada y/o los archivos .md que usted requiera para documentar su código. Tome el ejemplo de la forma en que está creada esta documentación.

versioning/PULL_REQUESTS.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ Todo cambio entre ramas debe seguir el manejo de pull requests como se indica en
1515
* Termine todos los archivos con un newline.
1616

1717
**NOTA:** Todo Pull Request en sus comentarios debe contener:
18-
* un link al documento o fuente de información donde está alojado el listado con descripción de todas las historias de usuario por las que se está haciendo el desarrollo.
19-
* el listado paso a paso de la configuración que es necesaria en la aplicación para que los cambios surtan efecto. Este paso es opcional
20-
* una certificación de las pruebas realizadas por parte del QA (Tester)
18+
* Un link al documento o fuente de información donde está alojado el listado con descripción de todas las historias de usuario por las que se está haciendo el desarrollo.
19+
* En el caso de un incidente (issue) debe contener en el cuerpo el identificador del issue que se está cerrando y si es posible el link del mismo
20+
* El listado paso a paso de la configuración que es necesaria en la aplicación para que los cambios surtan efecto. Este paso es opcional
21+
* Una certificación de las pruebas realizadas por parte del QA (Tester)
2122

2223
![Git Workflow](../assets/img/git-flow-infographics.png)
2324

0 commit comments

Comments
 (0)