CHK-TDT-001 Revisión de Pull Request

v 5.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 título y la descripción del Pull Request son claros y concisos, proporcionando suficiente contexto sobre los cambios realizados siguiendo el estándar de Pull Request definido por el equipo.

  Se ha asignado correctamente un revisor certificado.

• 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. Pueden ser imágenes o videos.

• Trazabilidad

  Se vincula cualquier artefacto de diseño utilizado en la RTM, en el caso de que existan. Esto puede incluir diagramas de flujo, diagramas de secuencia, de actividades, entre otros.

  Los artefactos de diseño actualizados se almacenan en un repositorio centralizado.

• Documentación del código

  Se incluyen comentarios claros y descriptivos en el código, que faciliten la comprensión del mismo. Siguiendo la Docstring Convention PEP 257.

  Se utiliza el estándar de documentación de código XML.

  Se actualiza la documentación externa, como las guías de usuario, para reflejar los nuevos cambios.

  Se asegura que los comentarios y la documentación no estén desactualizados o sean erróneos.

• Feedback

  Se proporciona feedback constructivo al autor del Pull Request, señalando áreas de mejora y posibles soluciones.

  Se fomenta una comunicación abierta y respetuosa, utilizando ejemplos específicos para ilustrar los puntos de mejora.

  Se reconocen concisamente los defectos del Pull Request, motivando al autor a resolverlos.

• Verificación

  El Pull Request es aprobado por al menos un miembro del equipo, que no sea el autor del mismo. Verificando que cumpla con las Checklist de Codificación y de Revisión de PR.

  Se realiza una segunda revisión si los cambios son significativos o complejos, para asegurar una mayor calidad.

  Se documenta la aprobación y las revisiones realizadas en GitHub.

TS

• Validación de interfaces

  Se verifican todas las interfaces nuevas o modificadas para asegurar que cumplen con los requisitos establecidos y no afectan negativamente a otras partes del sistema.

• Evaluación de impacto

  Se evalúa el impacto de los cambios propuestos en el sistema existente.

• Revisión de consistencia

  Se asegura que los cambios propuestos sean consistentes con la arquitectura, el diseño general del sistema y que no haya conflictos.

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 realizado	Análisis	Autor del cambio	Revisor(es)	Fecha de cambio
v 1.0	Creación de la checklist	N/A	Diego Sandoval, Daniel Cajas	Alejandra Cabrera	10/04/2024
v 2.0	Modificación de la checklist	N/A	Juan Pablo Cabrera		16/04/2024
v 2.1	Añadir estándar de documentación de código. Y aclaraciones	N/A	Alejandra Cabrera		18/04/2024
v 2.2	Añadir solucion de conflictos	N/A	Ricardo Rosales		18/04/2024
v 3.0	Checklist apegada al estándar de checklists	N/A	Alejandra Cabrera		29/04/2024
v 3.1	Cambio de nombre	N/A	Arturo Díaz	Ian Padrón	30/04/2024
v 3.2	Cambio a link relativo	Los links relativos avisan si se rompen	Ricardo Fernández	Carlos Velasco	1/05/2024
v 4.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
v 5.0	Actualización para PPQA y TS	Se añadieron prácticas detalladas para PPQA y se añadió la sección TS	Mike Tena	Alejandra Cabrera	17/05/2024