docs: add AGENTS.md agent guidelines aligned with repo conventions - #156
Conversation
|
Hi @ltmoerdani — opening this up with the reasoning for why 1. It's the file agents actually read. 2. It encodes standards we already enforce by hand. 3. No duplication, no drift. 4. It matches this repo, not a generic template. 5. Zero risk. Happy to trim, rewrite, or drop any section you don't agree with. The goal is a file you'd be glad an AI contributor read before opening its first PR. |
|
You will feel the value of AGENTS when you use it in real life's coding sessions. PEACE BE UPON YOU. |
|
Nice one @Fahad090NP, thanks for this. AGENTS.md is a solid addition and I verified the claims myself: the lint single-gate framing is accurate ( One thing before this lands: this repo also ships a more specific agent config plus the automation rules in CONTRIBUTING.md, so I'd rather AGENTS.md stay a short pointer to those instead of restating them, otherwise the rules drift apart over time. I'll also add a line about the merge policy (always merge commit, never squash, it's a hard rule here) since that's the one operational thing AGENTS.md doesn't cover. I can handle those tweaks after merge, no need for you to rework the PR. CI is green either way. |
📝 What does this change?
Adds
AGENTS.mdat the repo root — the machine-readable agent contract that GitHub natively surfaces to Copilot and other AI coding agents. It codifies this repo's existing automation rules (never push/PR/merge without permission, feature branches, Conventional Commits, strict-lint verification) and encodes the review standards we've converged on, all aligned with the codebase's actual style rather than a generic template.Docs-only — no runtime code.
🧪 How did you test it?
prettier --checkpasses onAGENTS.mdmarkdownlint-cli2(repo config) passes — 0 issues✅ Checklist
npm run compilepasses (docs-only — no code change)npm run lintpasses (docs-only — markdown/prettier verified)npm testpasses (docs-only — no code change)npm run packageproduces a VSIX (N/A — docs-only)