Estilo de código
- Se aplica SOLID, DRY y KISS para favorecer la mantenibilidad.
- Se usan comentarios breves según Better Comments:
// * puntos clave o recordatorios.
// -*- subpuntos o hija de punto clave.
// TODO tareas pendientes.
// - [ ] tarea puntual a completar.
// ! advertencias críticas.
// -!- subadvertencia o hija de advertencia crítica.
// ? dudas o decisiones sujetas a revisión.
// -?- subduda o hija de duda.
// FIX errores o inconsistencias a corregir.
- Se prefiere nombres semánticos y evitar comentarios obvios.
Convenciones de commits
- Se siguen Conventional Commits (
feat:, fix:, docs:, refactor:, test:, chore:).
- Mensajes en imperativo y breves (máx. 72 caracteres).
- Commits pequeños y enfocados.
Registro de decisiones
- Toda decisión técnica relevante debe documentarse mediante un ADR numerado en decisiones.
Flujo previo a un Pull Request
- Asegurar que las dependencias estén instaladas en el paquete afectado.
- Ejecutar linters y formateadores:
- Backend:
cd backend && npm run lint.
- Frontend:
cd frontend && npm run lint.
- Ejecutar pruebas:
- Backend:
cd backend && npm test.
- Frontend:
cd frontend && npm test.
- Verificar que los cambios estén cubiertos y que no existan errores.
Documentación relacionada