CHK-DGT-005 Revisión de Pull Request
v 2.0
Propósito
Garantizar la calidad y estandarización de los Pull Request
Notas introductorias
- La revisión de un Pull Request es una parte fundamental del proceso de desarrollo de software. A través de la revisión, se garantiza que el código cumple con los estándares de calidad y que se han cumplido los criterios de aceptación definidos para la user story. A continuación, se presentan los criterios de evaluación que se deben tener en cuenta al revisar un Pull Request.
- En la sección de "Criterios de Aceptación", se identifica con "CM" los criterios que pertenecen a Gestión de la Configuración y con "PPQA" los que pertenecen al Aseguramiento de la Calidad del Proceso y del Producto
Criterios de Aceptación
PPQA
-
Estándar de Pull Request
El Pull Request cumple con el estándar de Pull Request definido por el equipo.
-
Estándares de código
Dependiendo si el Pull Request es de Frontend o Backend, el código debe cumplir con la checklist correspondiente:
-
Pruebas
Se realizaron y pasaron las pruebas relevantes según lo definido en el plan de pruebas.
-
Criterios de aceptación
El Pull Request tiene evidencias de que se cumplen los criterios de aceptación definidos en su respectiva user story conforme al Especificación de Requerimientos de Software. Pueden ser imágenes o videos.
-
Trazabilidad
En caso de trabajar en Requisitos Funcionales (RF), se registró el cambio en la Matriz de Trazabilidad. Para ello, verificar que se encuentre lo siguiente:
- Nombre de la fase: Fase a la que pertenece el RF
- Req ID: Identificador del RF
- Módulo: Módulo al que pertenece el RF
- Análisis: Enlace al producto o evidencia de esta fase para el RF
- Diseño: Enlace al producto o evidencia de esta fase para el RF
- Desarrollo: Enlace al Pull Request de Frontend y/o Backend del RF
- Pruebas: Enlace al Pull Request del Backend con las pruebas unitarias y/o enlace a la matriz de pruebas de integración con las pruebas del Frontend
-
Análisis
Se actualizaron los siguientes artefactos si corresponde:
- Diccionario de datos,
- Modelo de entidad-relación
-
PVG
Se actualizó el Plan de valor ganado con la siguiente información:
- Valor ganado
- Costo real
- Fecha real
-
Documentación del código
Se incluyen comentarios claros y descriptivos en el código, que faciliten la comprensión del mismo siguiendo el EST-DTG-002.
Es fundamental que la revisión de un Pull Request sea rigurosa y exhaustiva, para garantizar la calidad del código y la correcta implementación de la user story. Al seguir estos criterios, aseguramos que el código cumpla con los estándares de calidad y que la solución propuesta sea robusta y eficiente.
Versión | Cambio | Análisis | Autor del cambio | Revisor(es) | Fecha de cambio |
---|---|---|---|---|---|
v 1.0 | Creación de la checklist | N/A | Diego Perdomo, Sergio Garnica | Carlos Velasco | 13/05/2024 |
v 2.0 | Agregar áreas de proceso CM y PPQA | Se identificó para cada criterio de la checklist si pertenece a PPQA o a CM | Carlos Velasco | Sergio Garnica, Diego Perdomo | 14/05/2024 |