Estándares de código
Documentación obligatoria por repositorio
Fuente
Convenciones generales de la organización, definidas en
Industrias-CTS/.github.
| Archivo | Regla |
|---|---|
README.md | Cada repositorio debe tenerlo, actualizado |
CLAUDE.md | Debe estar en la raíz del repositorio y mantenerse actualizado |
El README es lo primero que lee alguien nuevo antes de contribuir a un repo.
Ver Onboarding.
Idioma
Los mensajes de commit pueden ir en español o en inglés.
Pendiente
Definir el idioma del código: nombres de variables, funciones y comentarios. Hoy no está escrito, y mezclar idiomas dentro de un mismo repositorio dificulta la lectura.
Pendiente de definir
Pendiente
- Herramientas de formateo, linter y tipos, con su configuración.
- Convenciones de nombres y de estructura de carpetas.
- Manejo de errores y niveles de log.
- Convenciones de API.