Files

2.6 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.
.pi/settings.json Modelo por defecto de pi para el proyecto (defaultProvider, defaultModel). Lo crea elegir_modelo_proyecto o --modelo. Solo con /modelo-proyecto, a petición del usuario.

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 — explica dónde está el modelo por defecto y cómo cambiarlo; el criterio de selección por tarea queda PENDIENTE.
  • ## 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.

Modelo por defecto

  • Al crear el proyecto, el usuario elige el modelo en el selector de la herramienta elegir_modelo_proyecto (alternativa: --modelo proveedor/id).
  • Se guarda en <proyecto>/.pi/settings.json; pi lo aplica en cada sesión nueva del proyecto si éste es de confianza.
  • Se cambia en cualquier momento con /modelo-proyecto, que fusiona el valor con el resto de ajustes del fichero y activa el modelo en la sesión actual.