Skip to main content

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.

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.

Formato

<tipo>(<alcance>): <descripción en imperativo, minúsculas, sin punto>
Regla mental: el mensaje debe completar la frase “Si aplico este commit, este commit va a…”

Ejemplo anotado

feat(pages): agregar página de contacto institucional
^───^──────^ ^───────────────────────────────────────^
│   │         └─ descripción: qué hace, no cómo lo hace
│   └─────────── alcance: carpeta o sección afectada
└─────────────── tipo: categoría del cambio

Tipos de commit

TipoCuándo usarlo
featNueva sección, página o funcionalidad visible
estiloCambios en CSS: colores, fuentes, espaciado
fixCorrección de algo roto o mal renderizado
contenidoTextos, imágenes, logos, íconos
refactorReorganizar código sin cambiar lo que se ve
docsCambios en README u otra documentación
config.gitignore, metadatos, <head> del HTML
choreLimpieza, archivos sobrantes, renombrados

Alcances

Los alcances deben coincidir con la estructura real del repositorio:
AlcanceCarpeta / archivoEjemplo de uso
indexindex.htmlCambios en la página principal
pagespages/Agregar o editar subpáginas
csscss/Modificar archivos de estilos
assetsassets/Imágenes, logos, íconos, fuentes
jsjs/Scripts (cuando se incorporen)
docsdocs/ o README.mdDocumentación del proyecto
previewpreview/Capturas o GIFs de demostración
config.gitignore, <head>, metaConfiguración general del proyecto
Si el cambio toca múltiples carpetas sin un alcance claro, omite el paréntesis: refactor: separar estilos globales de los de componentes

Reglas

  1. Un commit = un cambio. Si el mensaje necesita “y”, separa en dos commits.
  2. Descripción en minúsculas, sin punto final, máximo 72 caracteres.
  3. Usa el imperativo: “agregar”, “corregir”, “eliminar” — nunca “agregué” o “se agrega”.
  4. El alcance es obligatorio cuando el cambio está claramente en una sola carpeta.
  5. Cuerpo opcional para explicar el por qué, no el qué (el diff ya muestra el qué).

Cuerpo del commit (cuando aplica)

fix(css): corregir desbordamiento del hero en pantallas < 375px

El padding horizontal del hero causaba scroll lateral en iPhone SE.
Se reemplazó el valor fijo por padding relativo con clamp().
El cuerpo va separado de la primera línea por una línea en blanco y explica el contexto o la razón del cambio, no los pasos técnicos que el diff ya refleja.

Ejemplos por tipo

feat(index): agregar sección de noticias institucionales
feat(pages): crear página de calendario académico
feat(js): agregar menú hamburguesa para mobile
estilo(css): ajustar paleta de colores a identidad institucional
estilo(css): aumentar contraste en textos sobre fondo oscuro
estilo(css): unificar espaciado de secciones con variables CSS
fix(css): corregir desbordamiento del navbar en tablet
fix(index): reparar enlace roto al portal de padres
fix(pages): restaurar scroll suave en página de contacto
contenido(assets): reemplazar logo por versión SVG oficial
contenido(index): actualizar texto del hero con misión institucional
contenido(pages): agregar fotos del cuerpo docente 2025
refactor(css): separar estilos del header en archivo propio
refactor(index): extraer sección de noticias a componente reutilizable
refactor(assets): reorganizar imágenes por sección
docs: agregar guía de contribución al README
docs: documentar estructura de carpetas del proyecto
docs(preview): actualizar capturas de pantalla con versión actual
config: agregar meta tags de Open Graph para redes sociales
config: actualizar .gitignore para excluir archivos del sistema
config: configurar favicon institucional
chore: eliminar archivos CSS sin usar del directorio raíz
chore: renombrar imágenes con convención kebab-case
chore: comprimir imágenes del directorio assets

Errores comunes

❌ Incorrecto✅ Correcto
fix: arreglé cosasfix(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 estilosDos commits: uno feat, uno estilo
FEAT(INDEX): Agregar Sección Hero.feat(index): agregar sección hero
contenido: imgcontenido(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:
FaseTipos predominantes
MVPfeat, contenido, estilo
v1.0fix, estilo, refactor
v2.0feat, config, js
v3.0feat, config, chore, docs

Build docs developers (and LLMs) love