Skip to content

Add REVIEW.md and agent permission rules - #40

Draft
steve-calvert-glean wants to merge 2 commits into
mainfrom
chore/review-md
Draft

steve-calvert-glean wants to merge 2 commits into
mainfrom
chore/review-md

Conversation

@steve-calvert-glean

@steve-calvert-glean steve-calvert-glean commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Problem

Reviewers and review agents have no written rules for this repo, so each review starts from generic advice. Nothing tells coding agents which actions they may take here without asking, such as commenting on PRs, merging, publishing, or pushing to main.

Change

  • REVIEW.md: this repo's review rules, drawn from CLAUDE.md (zod schemas as the source of truth, the artifact seam, guarded destructive paths, narrow partials, CLI docs) and the README's rule that targets come from official docs.
  • .claude/settings.json: agent permission rules in Claude Code syntax, using the draft-pr preset. Agents may push feature branches and open draft PRs. They ask before comments, reviews, merges, releases, publishing, force pushes and pushes to main.
  • AGENTS.md: the same rules in plain language ("Ask first", "Never"), a pointer to REVIEW.md, and the commit and PR conventions. The conventions come from the repo's merge settings, release tooling and recent history. This repo kept its agent guide in CLAUDE.md, so AGENTS.md is new and CLAUDE.md imports it with @AGENTS.md.
  • .codex/rules/permissions.rules: the same rules compiled for Codex, which loads them in trusted projects.

configure-agents review generated the rules files (gleanwork/configure-agents#1). configure-agents check --review-only passes.

Effect on contributors

Claude Code and Codex now ask before an agent runs a gated command in this repo, such as gh pr comment, gh pr review, gh release or npm publish. This applies to every contributor's agent sessions here. Nothing changes for commands people run themselves. No CI workflow runs an agent, so CI is unaffected.

.claude/ is git-ignored on some machines, so .claude/settings.json was added with git add -f.

CI

The production dependency audit fails on a sprintf-js advisory (via gray-matter and argparse) that was published after main last passed. It is unrelated to this change. #39 bumps the dependency and passes the same audit, so this PR passes once #39 merges.

REVIEW.md holds this repo's review rules for people and review agents.
.claude/settings.json holds the agent permission rules in Claude Code syntax
(draft-pr preset), AGENTS.md carries the same rules in prose plus the commit
and PR conventions, and .codex/rules/permissions.rules compiles them for
Codex. Generated with configure-agents review.
@steve-calvert-glean steve-calvert-glean added the internal Internal refactoring, cleanup, or maintenance work label Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Internal refactoring, cleanup, or maintenance work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant