Estándares de Código
Normativas técnicas para la uniformidad y escalabilidad del software en NextStep Devs.
01. Nomenclatura
Para garantizar que el código sea legible por cualquier miembro del equipo, aplicamos las siguientes convenciones:
- Variables y Funciones: Se debe utilizar estrictamente
camelCase(ejemplo:obtenerVideo,usuarioActivo). - Archivos y Directorios: Se debe utilizar
kebab-casepara toda la estructura de archivos (ejemplo:reproductor-principal.js). - Comentarios: Todo bloque de código cuya lógica sea compleja debe incluir una breve explicación técnica descriptiva.
02. Flujo de Trabajo en Git
El control de versiones es el pilar de nuestra colaboración. Seguimos un flujo de ramas estricto:
Restricción Crítica: Está prohibido realizar commits directamente sobre las ramas main o stable_version.
- Toda nueva tarea debe partir de la rama
previous_version. - Nomenclatura de ramas:
nombre-de-tu-tarea. - Al finalizar, se solicita un Merge hacia
previous_versionpara su auditoría técnica.
03. Organización del Proyecto
Se debe respetar la arquitectura modular establecida. No se permite la creación de carpetas en la raíz del proyecto sin previa consulta con el equipo de arquitectura. La jerarquía base se divide en:
├── backend/ # Lógica de Servidor
├── frontend/ # Interfaz de Usuario
├── nginx/ # Infraestructura (IaC)
├── scripts/ # Automatización
└── tests/ # Pruebas Unitarias
04. Protocolos de Prueba
Ninguna contribución será integrada si no supera las pruebas unitarias correspondientes:
- Backend: Ejecución obligatoria de
unittesten Python. - Frontend: Validación mediante
npm test.

0 Comentarios