Skip to content

docs(review): add REVIEW.md for the managed Claude Code Review - #183

Open
abhisek wants to merge 1 commit into
mainfrom
claude/eloquent-davinci-gdl71d
Open

abhisek wants to merge 1 commit into
mainfrom
claude/eloquent-davinci-gdl71d

Conversation

@abhisek

@abhisek abhisek commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

What changed

  • Adds REVIEW.md at the repo root.
  • No GitHub Actions Claude review job exists in this repo (grep -rli "claude-code-action" .github finds nothing), so this PR removes no workflow.

Why

The org now runs the managed Claude Code Review service. It replaces a GitHub Actions review: in other repos the Actions job duplicated the managed review with an old model and one agent, and a @claude comment started both. The managed service reads REVIEW.md for review-only instructions. dry is a shared library that control-tower, malysis, vet, pmg, gryph and cli import, so the review must know that a break of an exported API, or a change to a frozen output, reaches every tool.

REVIEW.md takes effect only after this PR merges, and only while main is a protected branch. The service reads it from the default branch, never from the PR.

Summary of REVIEW.md

  • Important means: a downstream caller breaks or behaves differently, a stored or frozen value changes, a secret leaks or a security check weakens, an error is lost, data is corrupt, a race or a panic.
  • At most five Nits per review. No Nits when the review has Important findings.
  • Do not report what CI checks (go test with go mod tidy, mockery and go generate, scripts/check-tui-discipline.sh, the vet dependency policy), format and import order (lefthook runs golangci-lint and gitleaks), generated files (api/api.gen.go, *_mock.go, go.sum) and upstream test data.
  • Always check: exported API compatibility (including variadic and interface breaks), frozen api/pb purl outputs and their pin tests, identity rule version bumps and PackageVersion comparisons, the copied OSV code, new modules in go.mod, dropped or unwrapped errors, secrets in logs and BeginEvent placement, crypto/rand and file-read checks in security-sensitive packages, shared state races, OS-specific code, tests and package docs (Nit).
  • Evidence rule: a claim about behavior needs a file:line citation.

Generated by Claude Code

Summary by CodeRabbit

  • Documentation
    • Added review guidance covering how to assess compatibility, tests, security-sensitive code, dependencies, errors, logging, and platform support.
    • Clarified which findings reviewers should report, set limits for minor issues, and added a checklist for common review considerations.
    • Behavioral claims in reviews must now include source citations.

The org now runs the managed Claude Code Review service. It reads
REVIEW.md from the default branch. Without the file, the review does not
know that a break of an exported API reaches every SafeDep tool, or
which outputs in api/pb are frozen.

REVIEW.md says what Important means for a shared library, caps the
Nits, lists what CI already checks, and names the rules to check on
each change. This repo had no GitHub Actions review job to remove.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01YBw4raEZwrmjTiDnV2md7o
@safedep

safedep Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

SafeDep Report Summary

Green Malicious Packages Badge Green Vulnerable Packages Badge Green Risky License Badge

No dependency changes detected. Nothing to scan.

View complete scan results →

This report is generated by SafeDep GitHub App

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Code review skipped — your organization has no extra usage available to pay for this review.

If your organization's extra usage balance is empty, an organization admin can add extra usage credits at claude.ai/admin-settings/usage. If its monthly spend limit was reached, an admin can raise it on the same page. If neither applies, contact Anthropic support.

Once extra usage is available, someone with write access to this repository can comment @claude review on this pull request to trigger a review.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-04T17:53:26.820635Z a8cc8a2 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

Adds REVIEW.md with finding criteria, exclusions, repository-specific review checks, and requirements for citing behavioral claims.

Changes: Review guidance

Layer / File(s) Summary
Finding thresholds and exclusions
REVIEW.md
Defines Important and Nit finding criteria, limits Nit findings, and lists excluded findings.
Repository checks and evidence
REVIEW.md
Adds checks for API compatibility, frozen outputs, errors, dependencies, security, shared state, OS behavior, tests, and package documentation. Requires source citations for behavioral claims.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: sahilb315, arunanshub

Merge Risk: Minimal · up to a8cc8

The review-guidance update presents no identified merge-blocking risk and is ready to merge after normal checks.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: adding REVIEW.md documentation for the managed Claude Code Review service.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Share
Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: QUIET
  • Plan: Advanced
  • Run ID: e43c711f-49b5-4af7-84d8-ac5a52d7f75a
Commits

Reviewing files that changed from the base of the PR and between 1a71021 and a8cc8a2.

Files selected for processing: 1
  • REVIEW.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

abhisek commented Nov 4, 2026

Copy link
Copy Markdown
Member Author

The build check failed twice, and each run failed in a different test. This PR adds only REVIEW.md, which no build or test reads. The Go workflow passed on main at the base of this PR (1a71021).

  • First run: TestGithubPackageRegistryAdapter_GetPackage failed with github api rate limit exceeded. The test calls the live GitHub API. The client takes its token from GITHUB_TOKEN (adapters/github.go:55), so a run without that variable is rate-limited.
  • Re-run: TestDockerSandboxExecute/run_command_with_sysbox-runc failed because the runner's sysbox-fs did not register the container. The test then dereferences nil at sandbox/sandbox_docker_test.go:95. The echo_hello case passed in the same run.

No fix exists yet. Both tests depend on the runner and the network, not on the code. Two possible fixes, each for a separate PR:

  1. Pass GITHUB_TOKEN to the go test step, or skip the registry test when no token is set.
  2. Skip the sysbox case when sysbox-fs does not start, and use require before line 95 so the case cannot panic.

Generated by Claude Code

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.

2 participants