{"name":"agents-md","title":"AGENTS.md template","description":"An AGENTS.md template and example with setup, checks, code style, testing and PR rules, plus a monorepo layout. Copy it into your repo.","category":"agents","updated":"2026-11-08","url":"https://sniptide.com/templates/agents-md","files":[{"name":"AGENTS.md","language":"markdown","content":"# AGENTS.md\n\n## Project\n\nAcme Dashboard is a Next.js app where customers track their orders. TypeScript throughout,\nPostgres through Drizzle, deployed as a Docker image.\n\n## Setup\n\n- Install dependencies: `pnpm install`\n- Copy the environment: `cp .env.example .env`\n- Start Postgres: `docker compose up -d db`\n- Run migrations: `pnpm db:migrate`\n- Start the dev server: `pnpm dev`\n\n## Checks\n\nRun these before you finish a task. All of them must pass.\n\n- `pnpm lint`\n- `pnpm typecheck`\n- `pnpm test`, or `pnpm test <path>` for one file\n\n## Code style\n\n- TypeScript strict mode, no `any`.\n- Named exports. One component per file in `components/`.\n- Database access only in `lib/db`. Pages and components call functions from there.\n- Format with Prettier (`pnpm format`). Don't hand-format.\n\n## Testing\n\n- Put tests next to the code as `*.test.ts`.\n- Add a test for every bug fix that fails without the fix.\n- Tests that touch the database use the `withTestDb` helper from `lib/db/testing.ts`.\n\n## Pull requests\n\n- Title: Conventional Commits, such as `feat(orders): add CSV export`.\n- Keep one change per pull request, and describe what you checked.\n- Update `docs/` in the same pull request when behavior changes.\n\n## Security\n\n- Never commit `.env` or any key, token or password.\n- Ask before you add a dependency or change CI.\n"}]}