Skip to content

docs: list the spec in AGENTS.md and say to update it with behaviour - #184

Merged
jbpros merged 4 commits into
mainfrom
docs/agents-spec
Oct 12, 2026
Merged

jbpros merged 4 commits into
mainfrom
docs/agents-spec

Conversation

@jbpros

@jbpros jbpros commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Follow-up to the review of #178. AGENTS.md had the spec: commit area but nothing else about the spec.

  • "Files" lists spec/ and spec_test.rego.
  • "Checks" describes the spec job from ci: check the spec's rules and schemas #183, and adds spec/check_rules.py and .github/spec-schemas.py to the checks to run before a change is done. The schema script runs in a virtual environment outside the repo, because Homebrew's Python refuses pip install outside one (externally-managed-environment).
  • "Docs" says a behaviour change updates its rule and cases in spec/, the schemas when a policy or report changes shape, and REFERENCE.md. A core: change that does so stays core:.

I ran every command in the checks list from the repo root on this branch, which has main merged in. opa test passes 997/997, regal finds no violations, check_rules.py exits 0, and the schema script prints 294 cases, 0 problems.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jbpros jbpros added the documentation Improvements or additions to documentation label Oct 12, 2026
jbpros and others added 3 commits October 12, 2026 22:46
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The checks to run before a change is done now include check_rules.py
and the schema script, run in a virtual environment because Homebrew's
Python refuses pip install outside one. The docs section says to update
the schemas when a policy or report changes shape, and that
spec_test.rego only catches behaviour a case covers.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@jbpros
jbpros marked this pull request as ready for review October 12, 2026 21:17
@jbpros
jbpros merged commit da34bb2 into main Oct 12, 2026
7 checks passed
@jbpros
jbpros deleted the docs/agents-spec branch October 12, 2026 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant