Buenas prácticas en revisiones de código: Manteniendo la calidad en devlog-ist/landing
En el proyecto devlog-ist/landing, nos enfocamos recientemente en optimizar la calidad del código y la estructura de nuestras configuraciones. Durante las revisiones de código, identificamos puntos clave que, aunque parecen triviales, impactan significativamente en el mantenimiento y la estabilidad a largo plazo del despliegue.
Optimización de configuraciones y entornos
Uno de los aprendizajes principales fue la gestión de configuraciones sensibles. Es fundamental asegurar que cualquier parámetro de entorno que requiera ser configurado por el usuario esté documentado correctamente en el archivo de ejemplo (por ejemplo, .env.example).
Además, durante la revisión, destacamos la importancia de:
- Encapsulamiento: Asegurar que las funcionalidades críticas o de entorno de producción estén debidamente protegidas mediante decoradores o directivas, como
@production. - Limpieza de código: Evitar la inclusión de migraciones vacías o archivos de dependencias innecesarios que no han sido validados o actualizados. La higiene del repositorio es vital para evitar ruido en el historial de cambios.
- Verificación de paquetes: Mantener la coherencia entre los cambios realizados en el sistema de gestión de paquetes y los archivos de bloqueo, evitando actualizaciones accidentales sin un propósito claro.
La importancia de los tests
Otro pilar discutido fue la necesidad de acompañar cada nuevo método o componente con sus respectivos tests unitarios. El uso de frameworks de pruebas es esencial para asegurar que las nuevas implementaciones no rompan funcionalidades existentes. Adoptar la costumbre de incluir pruebas desde el inicio del desarrollo permite identificar errores tempranos y garantiza una refactorización más segura.
Recuerden siempre validar la identación y la estructura de los datos, especialmente cuando se trabaja con archivos de configuración, ya que un error de formato puede generar comportamientos inesperados en la aplicación.
