Skip to content

docs: add AGENTS.md covering the conventions CI enforces - #84

Open
fbwoolf wants to merge 1 commit into
masterfrom
docs/agents-md
Open

fbwoolf wants to merge 1 commit into
masterfrom
docs/agents-md

Conversation

@fbwoolf

@fbwoolf fbwoolf commented Sep 19, 2026

Copy link
Copy Markdown
Collaborator

Closes #80.

The deny list, module-level item ordering, the nightly-only rustfmt settings and the contracts-before-crates build order are only discoverable today by failing CI. This states them once at the root, linking to the README for environment setup and to the spec for the engineering standards rather than restating either.

Three calls worth reviewing:

  • Added short sections on secret handling, comments and commit conventions, since those are what an agent gets wrong precisely because no lint catches them.
  • One file at the root for now. contracts/ is the obvious place for a nested one if the Solidity side outgrows its section.
  • The commit and branch conventions are inferred from the log rather than written down anywhere, so push back if they are not what the team wants recorded.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

EDW-027 Add AGENTS.md covering the conventions CI enforces

1 participant