2.5 KiB
name, description, license
| name | description | license |
|---|---|---|
| new-project | Genera la base documental de un proyecto nuevo (AGENTS.md, README.md, CHANGELOG.md, TODO.md, INSTALL.md y .gitignore) a partir de plantillas. Úsala cuando el usuario pida crear un proyecto, repositorio o directorio nuevo, inicializar su documentación o "montar el esqueleto" de un repo. | MIT |
new-project
Genera el esqueleto documental de un proyecto. Todas las plantillas están en
templates/ y el andamiaje lo hace scripts/new-project.sh.
Procedimiento
-
Recoge los datos que falten antes de ejecutar nada:
- ruta de destino (obligatoria);
- nombre del proyecto (por defecto, el nombre del directorio destino);
- descripción en una frase (obligatoria: se usa en README y AGENTS);
- autor (opcional; por defecto
git config user.name); - si hay que inicializar un repositorio git (
--git). No inventes la descripción: si el usuario no la da, pregúntala o propón una y confírmala.
-
Ejecuta el script desde este directorio de skill:
scripts/new-project.sh --nombre "Mi Proyecto" --descripcion "Qué hace" \ --git /ruta/al/proyectoEl script no sobreescribe ficheros existentes salvo con
--forcey muestra un resumen de lo creado. Usa--dry-runpara revisar antes. -
Revisa el resultado: abre
README.mdyAGENTS.mddel proyecto generado y completa lo que quede comoPENDIENTE(objetivos, stack, comandos de verificación reales). No dejes marcadores de plantilla ni secciones vacías. -
Ajusta
INSTALL.mdcon los requisitos y pasos reales del stack elegido. -
Commit inicial si se creó repo git:
git add -A && git commit -m "docs: base documental inicial" -
Informa al usuario de la ruta creada, los ficheros y del commit.
Reglas
- No ejecutes el script sobre un directorio que ya tiene
AGENTS.mdoREADME.mdsin avisar y confirmar (usaría--force). - Las secciones
## Reglas de modeloy## Reglas de funcionamientodeAGENTS.mdse dejan comoPENDIENTEa propósito: se acuerdan después, por proyecto. No las rellenes con suposiciones. - Idioma de los documentos generados: español.
- Rutas relativas siempre desde este directorio de skill.
Referencia
scripts/new-project.sh --help— todas las opciones.templates/— plantillas con marcadores{{PROYECTO}},{{DESCRIPCION}},{{AUTOR}},{{FECHA}},{{FECHA_ISO}}.references/plantillas.md— qué contiene cada documento y cuándo tocarlo.