Buenas prácticas en la revisión de código para el proyecto landing
Durante el desarrollo de nuestro proyecto landing, hemos identificado puntos clave para optimizar la calidad del código y asegurar la estabilidad de las funcionalidades. A través del proceso de revisión, hemos consolidado una serie de recomendaciones esenciales para mantener un estándar profesional en el equipo.
Organización de configuraciones
Es fundamental evitar la anidación excesiva al definir configuraciones. Si cada punto representa un nivel de anidación en un arreglo, la estructura se vuelve rápidamente difícil de mantener. Buscamos siempre una configuración plana y legible.
Encapsulamiento y visibilidad
Al trabajar en componentes, el uso de directivas como @production es vital para aislar comportamientos que no deben ejecutarse en entornos de desarrollo o pruebas. Esto garantiza que la lógica de negocio solo esté activa donde es necesario.
Mantenibilidad y Calidad
- Pruebas Automatizadas: Todo método nuevo debe ir acompañado de su correspondiente prueba unitaria utilizando el framework de testing del lenguaje para asegurar su correcto funcionamiento.
- Limpieza: Debemos eliminar migraciones vacías o configuraciones redundantes que solo añaden ruido al repositorio.
- Gestión de dependencias: Evitar modificaciones innecesarias en los archivos de bloqueo de paquetes (
package-lock.json) si no se ha realizado una instalación real de nuevas librerías.
Documentación del entorno
Recuerden mantener siempre actualizado el archivo .env.example. Es necesario documentar los valores requeridos para el funcionamiento de las nuevas características, incluyendo, cuando sea relevante, capturas de pantalla o guías claras sobre las notificaciones (como correos electrónicos) que el sistema debe emitir.
Generated with Gitvlg.com