Add AGENTS.md and REVIEW.md for contributor and AI agent guidance#620
Merged
Conversation
bwesterb
approved these changes
Jun 4, 2026
cjpatton
approved these changes
Jun 4, 2026
cjpatton
left a comment
Contributor
There was a problem hiding this comment.
Looks good, thank you Andrew!
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.
Adds two contributor-facing documents:
AGENTS.md— guidance for AI coding agents (and new human contributors) working in this repo. Covers security expectations, testing conventions, theunsafe/dependency policy, code generation and assembly rules, API/compatibility expectations, lint contract, and the escalation paths.REVIEW.md— a code review checklist mirroring what CI already enforces plus the human-judgement items reviewers should add on top.Approach
Every rule is grounded in something already in the tree —
.golangci.yaml,go.mod,.github/workflows/ci-actions.yml, theMakefile, or specific recent commits. The goal was to encode the tacit conventions a maintainer already follows so that a new contributor (or AI agent) starts from the same baseline, without inventing aspirational policy.Notable choices:
sign/bls,ecc/bls12381,zk/qndleq,pki), KAT regeneration (91088f2), and shadow checks (6223887).unsafeas permitted-but-scrutinized, reflecting actual usage insimd/keccakf1600,internal/sha3,dh/csidh,ecc/fourq.depguardallowlist verbatim from.golangci.yaml.[email protected]) for vulnerability disclosure rather than inventing a new flow.Happy to iterate on any specifics — these are intended as a living baseline the maintainers own going forward, not a finished policy document.