From 12b72196b6139a789683c4c1d44b36cc9353cd98 Mon Sep 17 00:00:00 2001 From: CsUtil <45512166+cs-util@users.noreply.github.com> Date: Fri, 24 Oct 2025 15:24:01 +0000 Subject: [PATCH 1/3] Refactor AGENTS.md for clarity and structure; update package.json to include AGENTS.md in formatting script --- AGENTS.md | 55 +++++++++++++++++++++++++++++----------------------- package.json | 2 +- 2 files changed, 32 insertions(+), 25 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 09003d0..d0d32f7 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,9 +1,12 @@ +# General -# Rules +- The readme.md contains the full spec of the application. Read it end-to-end to understand the full context. +- You must follow the instructions in the agent.md file while working on your task and regularly review if you are still aligned with these instructions and the spec. +- Do not stop until every acceptance criterion is implemented, verified locally and prepared for review. +- **Co-locate docs**: every code file must have a matching `*.md` sidecar that explains it in detail. -## General - This is a minimal local first web app (static HTML + modular JS). Prefer tailwind over custom CSS. -- Entrypoint: `index.html` (+ static pages in `pages/`) +- Entrypoint: `index.html` (+ static pages in `pages/` if any needed) - The code is composed of small, focused modules in `src/` (`components/`, `utils/`, ..) with colocated tests - Run `npm test` and `npm outdated` at the start and end of each significant task and weekly at minimum; keep dependencies healthy. Prefer bumping to the `Wanted` version unless blocked by incompatibilities (document any exceptions). Also run `npm audit` to catch security issues even when versions are current - `README.md` typically contains big picture dev. spec and context. It should be kept up to date whenever the code is ready for a PR @@ -12,37 +15,41 @@ - When external documentation could be consulted, do so to validate your plan makes sense. If you lack a browsing/online search tool, ask the user to run an online search for you (e.g., "Please search for \"x\" and paste back the findings") ## Dependencies & no-build approach to use + This project follows a no-build, static workflow: + - Use native ES modules and `