From 4851f0e68e3db92226a477983badea1e0173255b Mon Sep 17 00:00:00 2001 From: a01653 <60973366+a01653@users.noreply.github.com> Date: Mon, 19 Oct 2026 21:28:11 +0100 Subject: [PATCH] docs: harmonize workflow instructions and scope checks --- AGENTS.md | 33 ++++++++++++++++++++++++++++++++- CLAUDE.md | 2 ++ README.md | 2 ++ 3 files changed, 36 insertions(+), 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index e5627be..a1b801e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -37,8 +37,39 @@ Una versión por entrega. No incrementarla por ajustes, previews o cambios docum ## DTS y manuales -`docs/DTS.md` es la fuente principal. `docs/latex/DTS_Drop_Route.tex` y su PDF son derivados. Los manuales Markdown y sus derivados están cerrados desde DR-007. +`docs/DTS.md` es la fuente principal. `docs/latex/DTS_Drop_Route.tex` y su PDF son derivados. Los manuales Markdown y sus derivados se mantienen cuando cambie de forma material el uso, las pantallas, los flujos o las limitaciones visibles para el usuario. La política `docs/documentation-policy.json` está en `required`: `npm run docs:check` y `npm run docs:check:final` exigen que DTS y manuales derivados estén sincronizados. Si una ampliación cambia materialmente arquitectura, navegación, persistencia, build o límites descritos en el DTS, actualizar el Markdown y regenerar LaTeX/PDF en el mismo cierre documental; no modificar a mano los derivados ni rebajar la política para hacer pasar la CI. README, requisitos, órdenes de trabajo y registros de validación deben reflejar el estado real de cada entrega. + +## Flujo común de trabajo y cierre + +Estas reglas armonizan el flujo con Mástil Escalas y Compás a compás. Conserva las comprobaciones y restricciones específicas de Drop Route descritas arriba. + +### Rama y alcance + +- Antes de editar, revisa `git status` y la rama activa. Actualiza `main` con `git pull --ff-only origin main` y crea una rama `docs/`, `fix/` o `feat/` adecuada al cambio. +- Mantén un objetivo acotado por rama y conserva cualquier cambio previo ajeno a la tarea. Ejecuta las pruebas dirigidas mientras desarrollas. +- No mezcles una rama de documentación con cambios funcionales sin relación. + +### Cierre y pruebas + +- Para cambios de aplicación, ejecuta una sola batería final sobre el estado exacto que entregarás: `npm run validate`, `npm run lint`, `npm run build` y `npm run test:e2e`. +- En cambios solo documentales, valida los archivos y herramientas afectados; no ejecutes pruebas de aplicación ni E2E si no cambia su comportamiento. Para cambios en fuentes de manuales o DTS, ejecuta `npm run docs:build`, `npm run docs:check:final` y revisa visualmente todos los PDF generados. +- Si una rama combina documentación y aplicación, aplica también la batería de aplicación. +- Registra resultados reales y pendientes en el registro de validación de la entrega. No declares pruebas que no se hayan ejecutado. + +### Manual, DTS y README + +- Mantén las fuentes Markdown de manuales y `docs/DTS.md` como fuentes editables; actualízalas cuando cambie materialmente su contenido. Regenera LaTeX/PDF con `npm run docs:build` y valida sus derivados; nunca los edites a mano. +- Usa como referencia editorial el manual de Compás a compás: contenido organizado por tareas, pasos breves, nombres exactos de controles, ejemplos y límites explícitos, capturas explicadas y pies consistentes. Conserva la identidad visual y estructura propia de Drop Route. +- Actualiza el DTS ante cambios relevantes de arquitectura, modelo, persistencia, navegación, construcción, despliegue, pruebas o límites. +- Mantén el README fiel a la funcionalidad publicada, requisitos, instalación, comandos, enlaces de manual/DTS y límites conocidos. El estado de publicación o CI solo se presenta como comprobado cuando se haya verificado en GitHub; el detalle de ejecución va en validación. +- No cambies versión solo por una actualización documental. + +### Publicación y entrega + +- No hagas commit, push, merge, release ni despliegue sin autorización expresa. +- Tras una publicación autorizada, comprueba el SHA remoto, GitHub Actions y Pages antes de declarar el cambio publicado. +- Resume rama, archivos modificados, documentación actualizada, pruebas ejecutadas y resultados pendientes. diff --git a/CLAUDE.md b/CLAUDE.md index 1779588..2043c35 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -40,4 +40,6 @@ Los tests de la base usan node:test y verifican los datos, el icono y el generad Distingue siempre lo existente de lo planificado. Actualiza los requisitos y la documentación de la misma rama cuando cambie el comportamiento documentado. La política documental está en modo `required`: no alteres DTS o manuales derivados sin regenerarlos y validarlos. +Al cerrar una entrega, sincroniza también el README con el estado verificable de GitHub y sigue en manuales el estilo orientado a tareas de Compás a compás, conservando la estructura y presentación propias de Drop Route. Aplica el flujo de ramas y cierre de `AGENTS.md`. + Referencia de instrucciones persistentes: https://code.claude.com/docs/en/memory diff --git a/README.md b/README.md index d169816..e7a1b6a 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,8 @@ La aplicación está publicada en: ## Integración continua +Consulta las [ejecuciones de GitHub Actions](https://github.com/a01653/Drop_Route/actions) para el estado remoto de validación y publicación. Este README describe el estado publicado; los resultados detallados de cada entrega se registran en `docs/validation/`. + `.github/workflows/validate-foundation.yml` ejecuta dos trabajos. `foundation` valida datos, auditoría musical, tests de base y documentación estricta. `app` ejecuta typecheck, lint, unitarias, build, E2E y genera las capturas de los manuales como artefacto. ## Límites actuales