AGENTS.md for a TypeScript repo
A project file for coding agents that names the commands, the boundaries and what must never be touched automatically.
AI Place Hub
61
# Repo
TypeScript, pnpm, Vite. Tests with Vitest. Node 20.
## Commands
- Install: pnpm install
- Dev: pnpm dev
- Test: pnpm test
- Typecheck: pnpm typecheck
- Lint: pnpm lint --fix
Run typecheck and test before saying a change is finished. If either fails, fix it or report it - do not describe the change as done.
## Boundaries
- Never edit files in src/generated/ - they come from the schema.
- Never change package versions or lockfiles without asking.
- Never commit, push or open a pull request unless explicitly asked in this session.
- Migrations in db/migrations/ are append-only. Do not edit an existing one.
## Style
- Strict mode is on. Do not add `any` or `@ts-ignore` to make an error go away - fix the type.
- Prefer a named export. Default exports only where a framework requires one.
- No new runtime dependency without asking.Notes from the author
OpenAI Codex and several other agent harnesses read this file. Keep the command list accurate. A wrong test command turns every run into a debugging session about the harness. The append-only migrations rule heads off the costliest mistake an agent can make in a repo with a database.
For information only, not professional advice. You use it at your own risk and we are not liable for any loss or damage. See the disclaimer.
Tagged