1.9 KiB
1.9 KiB
Plantillas de la base documental
Qué genera new-project.sh y cuándo hay que tocar cada documento.
| Documento | Para qué sirve | Cuándo actualizarlo |
|---|---|---|
AGENTS.md |
Reglas de trabajo para agentes y colaboradores: flujo, commits, verificación y las futuras reglas de modelo y de funcionamiento. | Al cambiar el flujo, las reglas, los comandos de verificación o al fijar las reglas de modelo. |
README.md |
Puerta de entrada: qué es el proyecto, estado, instalación rápida, uso y estructura. | Al cambiar el propósito, el uso o la estructura. |
INSTALL.md |
Instalación reproducible: requisitos, dependencias, configuración, verificación, arranque, actualización y desinstalación. | Al añadir dependencias, variables de entorno o cambiar pasos de instalación. |
CHANGELOG.md |
Historial Keep a Changelog: Añadido / Cambiado / Corregido / Eliminado. |
En cada cambio, sin excepción. |
TODO.md |
Tareas en curso, pendientes y hechas, incluida la deuda técnica. | Al abrir o cerrar tareas. |
.gitignore |
Exclusiones básicas: secretos, dependencias descargadas, artefactos de build, logs. | Al detectar ficheros que no deben versionarse. |
Marcadores
El script sustituye estos marcadores en todas las plantillas:
| Marcador | Valor |
|---|---|
{{PROYECTO}} |
--nombre o, si falta, el nombre del directorio destino. |
{{DESCRIPCION}} |
--descripcion o un PENDIENTE explícito. |
{{AUTOR}} |
--autor o git config user.name. |
{{FECHA}} y {{FECHA_ISO}} |
Fecha de ejecución en formato AAAA-MM-DD. |
Secciones reservadas
AGENTS.md incluye a propósito dos secciones con PENDIENTE:
## Reglas de modelo— modelo de pi, contexto y criterio de selección.## Reglas de funcionamiento— estándares, ramas, revisión y automatización.
No se rellenan al generar el proyecto: se acuerdan después, proyecto a proyecto.