CHK-TDT-004 Checklist de Codificación

v 6.0

Propósito

La checklist de codificación es una herramienta que permite verificar la calidad y consistencia del código fuente de un proyecto de software. Asegurar que cada componente cumpla con los siguientes criterios es fundamental para garantizar la legibilidad, mantenibilidad y eficiencia del código.

Notas introductorias

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

• Inconsistencia

  El desarrollo debe ser coherente con la información proporcionada durante el análisis y el diseño de requerimientos. Debe mostrar cómo se abordará el problema y cómo se cumplirán los criterios de aceptación.

• Nomenclatura

  Comprobar que todos los nombres (clases, variables, archivos) están en español y siguen las convenciones de nomenclatura establecidas en el estándar de codificación, y que los nombres de tablas y campos de base de datos están en snake_case.

• Formato de Código

  Comprobar el uso correcto de comillas dobles para strings en Python y XML. Asegurarse de que se utilizan template strings (f-strings) para construir mensajes que incluyen variables.

• Uso de Funciones y Clases

  Comprobar que todas las clases, métodos y modelos están bien documentados y son fáciles de entender, y que las implementaciones de las vistas están completas y claras.

• Estándares y Prácticas

  Confirmar que no hay errores con PyLint, utilizando el comando dentro de pylintTest.ps1 (PPQA).

• Manejo de Errores

  Asegurar el manejo de errores en llamadas asíncronas.

• Organización de Archivos

  Confirmar que los archivos están en las carpetas correctas según su tipo (models/, views/, controllers/, data/, security/, tests/, wizards).

• Seguridad y Configuración

  Verificar que no se revela información confidencial en el código, y que las claves secretas están en variables de entorno.

Versión	Cambio realizado	Análisis	Autor del cambio	Revisado por	Fecha de cambio
v 1.0	N/A	Creación de la checklist	Juan Pablo Cabrera Quiroga	Diego Sandoval	16/04/2024
v 2.0	N/A	Corrección de estilo y checklist	Diego Sandoval	Daniel Cajas y Alejandra Cabrera	18/04/2024
v 3.0	N/A	Ajuste de checklist	Daniel Fuentes		29/04/2024
v 3.1	Cambio a link relativo	Los links relativos avisan si se rompen	Ricardo Fernández		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	Reordenar los criterios de la checklist	Se reordenaron los crierios de la checklist para que los criterios se más se incumplen vayan primero.	Carlos Velasco		22/05/2024
v 6.0	Criterio de Inconsistencia	Agregar criterio de Inconsistencia para aclarar cuándo existen inconsistencias en un requerimient entre fases	Sergio Garnica	Alejandra Cabrera	23/05/2024