El proyecto usa una convención de commits estructurada inspirada en Conventional Commits, adaptada con tipos en español y nombres de alcance que coinciden directamente con las carpetas del repositorio. Esto garantiza un historial de Git legible, trazable y consistente entre todos los colaboradores.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/g4lvan/demo_page_colegio.github.io/llms.txt
Use this file to discover all available pages before exploring further.
Formato
Regla mental: el mensaje debe completar la frase “Si aplico este commit, este commit va a…”
Ejemplo anotado
Tipos de commit
| Tipo | Cuándo usarlo |
|---|---|
feat | Nueva sección, página o funcionalidad visible |
estilo | Cambios en CSS: colores, fuentes, espaciado |
fix | Corrección de algo roto o mal renderizado |
contenido | Textos, imágenes, logos, íconos |
refactor | Reorganizar código sin cambiar lo que se ve |
docs | Cambios en README u otra documentación |
config | .gitignore, metadatos, <head> del HTML |
chore | Limpieza, archivos sobrantes, renombrados |
Alcances
Los alcances deben coincidir con la estructura real del repositorio:| Alcance | Carpeta / archivo | Ejemplo de uso |
|---|---|---|
index | index.html | Cambios en la página principal |
pages | pages/ | Agregar o editar subpáginas |
css | css/ | Modificar archivos de estilos |
assets | assets/ | Imágenes, logos, íconos, fuentes |
js | js/ | Scripts (cuando se incorporen) |
docs | docs/ o README.md | Documentación del proyecto |
preview | preview/ | Capturas o GIFs de demostración |
config | .gitignore, <head>, meta | Configuración general del proyecto |
Reglas
- Un commit = un cambio. Si el mensaje necesita “y”, separa en dos commits.
- Descripción en minúsculas, sin punto final, máximo 72 caracteres.
- Usa el imperativo: “agregar”, “corregir”, “eliminar” — nunca “agregué” o “se agrega”.
- El alcance es obligatorio cuando el cambio está claramente en una sola carpeta.
- Cuerpo opcional para explicar el por qué, no el qué (el diff ya muestra el qué).
Cuerpo del commit (cuando aplica)
Ejemplos por tipo
feat — nueva función o sección
feat — nueva función o sección
estilo — cambios visuales en CSS
estilo — cambios visuales en CSS
fix — corrección de algo roto
fix — corrección de algo roto
contenido — textos, imágenes, logos
contenido — textos, imágenes, logos
refactor — reorganizar sin cambiar comportamiento
refactor — reorganizar sin cambiar comportamiento
docs — documentación
docs — documentación
config — configuración
config — configuración
chore — mantenimiento
chore — mantenimiento
Errores comunes
| ❌ Incorrecto | ✅ Correcto |
|---|---|
fix: arreglé cosas | fix(css): corregir alineación del footer en mobile |
update: cambios varios | (separar en commits individuales por tipo) |
feat: nueva sección y corrección de estilos | Dos commits: uno feat, uno estilo |
FEAT(INDEX): Agregar Sección Hero. | feat(index): agregar sección hero |
contenido: img | contenido(assets): reemplazar foto principal del hero |
Fases del proyecto
Referencia para contextualizar qué tipos de commit son más frecuentes en cada etapa del roadmap:| Fase | Tipos predominantes |
|---|---|
| MVP | feat, contenido, estilo |
| v1.0 | fix, estilo, refactor |
| v2.0 | feat, config, js |
| v3.0 | feat, config, chore, docs |