chore: add AGENTS.md with repo context for agents#825
Open
MattPereira wants to merge 3 commits intomainfrom
Open
chore: add AGENTS.md with repo context for agents#825MattPereira wants to merge 3 commits intomainfrom
MattPereira wants to merge 3 commits intomainfrom
Conversation
Member
Author
|
checkout docs for the emerging standards if interested to learn more: scaffold ETH has pretty good example of finely tuned AGENTS.md: |
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
brunoguerios
approved these changes
Apr 23, 2026
Member
brunoguerios
left a comment
There was a problem hiding this comment.
That's a great addition 👏
I've been navigating SDKs from other organizations and these files help a lot.
Thanks for the initiative 🙏
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AGENTS.mdat the repo root covering commands, the Anvil-fork testing model, theprotocolVersion(V1 CowAmm / V2 / V3) dispatch pattern, data providers, ABI/address-map locations, and conventions (Biome, dpdm, typed error factories, changesets)..agents/skills/changeset/SKILL.md— a tool-agnostic skill that tells agents to write.changeset/<slug>.mddirectly (sincepnpm changesetis interactive and can't be driven from an agent), with bump-selection rules and a "when to skip" guard so PRs touchingsrc/**don't ship without release notes.Why this helps agent work on this repo
src/,test/,package.json,vitest.config.mts,biome.json, and the deployment maps every session just to rediscover that V2/V3/CowAmm are dispatched offprotocolVersion, that each test spins up its own Anvil fork at a pinnedforkBlockNumber, that@/*maps tosrc/*, and where contract addresses live. That context is now one read away.query/buildCall/buildCallWithPermit2entity contract,maxForks: 3cap, per-pool-type input validators,pnpm update:deploymentsinstead of hand-editing address maps, changeset-gated releases — so agents extend existing patterns rather than inventing new ones or producing plausible-but-wrong suggestions.Test plan
AGENTS.mdon GitHub for accuracy🤖 Generated with Claude Code