docs: add AGENTS.md for coding agents - #98
Merged
Merged
Conversation
AGENTS.md covers the commands CI runs, the plugin contract (what breaks plugins, add-only proto changes, fallbacks for older peers, optional interfaces), the changes that must go together, working against a local api, and agent- vs API-owned evidence props. CLAUDE.md imports it. Also pin protoc-gen-go to v1.36.11 in buf.gen.yaml, the version the committed code was generated with. Regenerating gives no diff. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Advanced Run ID:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This was referenced Oct 1, 2026
gusfcarvalho
approved these changes
Oct 1, 2026
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
AGENTS.md, guidance for coding agents (Claude Code, Codex, Copilot, Cursor), plus a one-lineCLAUDE.md(@AGENTS.md) so Claude Code loads it.It covers what isn't obvious from the code:
make test,gofmt -l .,make check-opa-version), and that the gofmt check fails on any dirty tree;Unimplementedfallback pattern for older peers, and optional interfaces instead of newRunnermethods;docs/policy_artifacts.md, api bump + OPA version);go.work, test withGOWORK=off);policies/directory.Also pins
buf.build/protocolbuffers/go:v1.36.11inbuf.gen.yaml. It was unpinned, so a new release would churn every generated file; with the pin,buf generatereproduces the committed code exactly.Every command was run on
main, and the paths checked. A fresh agent given onlyCLAUDE.mdplanned a plugin-facing change correctly; the gaps it hit (optional plugin behaviour, installing buf, the unpinned plugin) are covered.Companion PRs: compliance-framework/api#467 and compliance-framework/ui#319.
🤖 Generated with Claude Code