From 7a9485b3e751a4c76ad5cee200790ce5183da9be Mon Sep 17 00:00:00 2001 From: Alessandra Vertrees Date: Mon, 22 Jun 2026 12:49:21 -0400 Subject: [PATCH 1/2] draft generatic AGENTS.md template --- ai-guidelines/templates/AGENTS.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 ai-guidelines/templates/AGENTS.md diff --git a/ai-guidelines/templates/AGENTS.md b/ai-guidelines/templates/AGENTS.md new file mode 100644 index 0000000..e69de29 From 6fd9c4c303a99702893b4db08e5396c23a769b6d Mon Sep 17 00:00:00 2001 From: Alessandra Vertrees Date: Mon, 22 Jun 2026 13:58:36 -0400 Subject: [PATCH 2/2] add contents --- ai-guidelines/templates/AGENTS.md | 66 +++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/ai-guidelines/templates/AGENTS.md b/ai-guidelines/templates/AGENTS.md index e69de29..05541f0 100644 --- a/ai-guidelines/templates/AGENTS.md +++ b/ai-guidelines/templates/AGENTS.md @@ -0,0 +1,66 @@ +# AGENTS.md + +## Project Overview + +[One sentence: language/framework, key versions, what makes this repo architecturally non-standard] + +## Tech Stack + +- Framework: `[ie. Next.js 15 (App Router + Pages Router hybrid)]` +- Language: `[ie. TypeScript]` +- Package Manager: `[ie. pnpm (always use pnpm, never npm)]` + +## Key Commands + +- Install: `[command]` +- Dev server: `[command]` +- Run all tests: `[command]` +- Run one test: `[command with path/pattern flag]` +- Lint: `[command]` +- Build/compile: `[command]` _(if applicable)_ + +## Non-Obvious Patterns + +### [Pattern name] + +[1–3 sentences explaining the mechanism, not just the rule] + +## Code Style + +- [Convention or constraint] +- [Convention or constraint] + +## Testing Rules + +- Write tests for all new functionality. +- [Mocking/stubbing convention for this repo] +- [External service strategy: VCR cassettes / webmock / pytest-httpretty / MSW / etc.] +- Run `[test command]` before marking any task complete. +- Tests must be deterministic and isolated — no order-dependent state. + +## Boundaries + +### Always fine + +- Read files and list directory contents +- Run lint, typecheck, and single test files +- Add or edit tests + +### Ask first + +- Install or remove dependencies (Gemfile, package.json, requirements.txt) +- Delete files +- Make schema or migration changes +- Open PRs or push to any branch + +### Never + +- Commit `.env`, secrets, credentials, or API keys +- Force push to `main` or any protected branch +- Modify generated or vendored directories: `vendor/`, `dist/`, `build/`, `node_modules/`, `app/assets/builds/` +- [Any repo-specific protected paths — e.g., Solr config, IIIF schema files] + +## Project Structure + +- `[path]` — [why it's worth calling out] +- `[path]` — [why it's worth calling out] \ No newline at end of file