Version history: Minimal AGENTS.md starter
v1
scan: pass2026-08-11 — Initial versionInitial version.
v2
scan: pass2026-08-13 — First-party content refresh# AGENTS.md ## What this project is - One paragraph: what the product does and who it is for.+ One paragraph: what the product does, who it is for, and the one thing an agent + must not break. Link the README for setup; keep this file about *how to work*. ## Commands - - `pnpm dev` — start the dev server - - `pnpm test` — run tests - - `pnpm lint && pnpm typecheck` — must pass before any commit+ Run these; do not invent substitutes. + - `pnpm dev` — web app + - `pnpm test` — unit + integration + - `pnpm test:e2e` — Playwright (stop anything on :3000 first) + - `pnpm lint && pnpm typecheck` — required before a commit + ## Conventions - - Match existing patterns before introducing new ones. - - Small, focused commits with Conventional Commit messages.+ - Match existing naming, types, and file layout before adding abstractions. + - Small diffs. One logical change per commit (Conventional Commits). + - Comments only for non-obvious business rules. ## Hard rules - - Never commit secrets or .env files. - - Ask before adding dependencies.+ - Never commit secrets, `.env`, or real credentials. + - Ask before adding a dependency or a paid service. + - Do not weaken auth checks, scan gates, or license verification. + - Scan fixtures stay inert — never functional payloads.
v3
currentscan: pass2026-11-02 — Generalized: the Commands section is now explicit placeholders instead of one project's pnpm scripts, and the Hard rules no longer reference Waxmark-internal scan gates and license checks; added 'keep this file current'.# AGENTS.md ## What this project is One paragraph: what the product does, who it is for, and the one thing an agent must not break. Link the README for setup; keep this file about *how to work*. ## Commands - Run these; do not invent substitutes.+ Run these; do not invent substitutes. Replace with your project's real commands. - - `pnpm dev` — web app - - `pnpm test` — unit + integration - - `pnpm test:e2e` — Playwright (stop anything on :3000 first) - - `pnpm lint && pnpm typecheck` — required before a commit+ - `<dev command>` — run the app locally (e.g. `pnpm dev`, `make run`) + - `<test command>` — unit + integration tests + - `<e2e command>` — browser tests, if any (note anything that must be stopped first) + - `<lint and typecheck command>` — required before a commit ## Conventions - Match existing naming, types, and file layout before adding abstractions. - Small diffs. One logical change per commit (Conventional Commits). - Comments only for non-obvious business rules. ## Hard rules - Never commit secrets, `.env`, or real credentials.- - Ask before adding a dependency or a paid service. - - Do not weaken auth checks, scan gates, or license verification. - - Scan fixtures stay inert — never functional payloads.+ - Ask before adding a dependency, a paid service, or a schema change. + - Do not weaken auth checks, input validation, or test assertions to make something pass. + - Test fixtures stay inert: no live credentials, no functional exploit payloads. + - Update this file when a command or rule above changes.