56 lines
778 B
Markdown
56 lines
778 B
Markdown
|
# Convenciones del proyecto
|
||
|
|
|
||
|
|
## Objetivo
|
||
|
|
|
||
|
|
Centralizar convenciones generales que afecten a todo el repositorio.
|
||
|
|
|
||
|
|
## Idioma
|
||
|
|
|
||
|
|
- Código e identificadores: [definir]
|
||
|
|
- Comentarios: [definir]
|
||
|
|
- Documentación: [definir]
|
||
|
|
|
||
|
|
## Naming
|
||
|
|
|
||
|
|
- Ficheros: [convención]
|
||
|
|
- Directorios: [convención]
|
||
|
|
- Clases / tipos: [convención]
|
||
|
|
- Variables / funciones: [convención]
|
||
|
|
- Constantes: [convención]
|
||
|
|
|
||
|
|
## Estructura de carpetas
|
||
|
|
|
||
|
|
[Convenciones principales.]
|
||
|
|
|
||
|
|
## Tipado
|
||
|
|
|
||
|
|
[Reglas principales.]
|
||
|
|
|
||
|
|
## Validación
|
||
|
|
|
||
|
|
[Reglas principales.]
|
||
|
|
|
||
|
|
## Errores
|
||
|
|
|
||
|
|
[Reglas principales.]
|
||
|
|
|
||
|
|
## Async
|
||
|
|
|
||
|
|
[Reglas principales.]
|
||
|
|
|
||
|
|
## Imports
|
||
|
|
|
||
|
|
[Reglas principales.]
|
||
|
|
|
||
|
|
## Dependencias
|
||
|
|
|
||
|
|
[Reglas para añadir o actualizar dependencias.]
|
||
|
|
|
||
|
|
## Git
|
||
|
|
|
||
|
|
[Convenciones relevantes.]
|
||
|
|
|
||
|
|
## Documentación
|
||
|
|
|
||
|
|
[Convenciones de actualización y SSOT.]
|