Skip to content

chore: add REVIEW.md, update AI review docs#8312

Merged
paulbalaji merged 3 commits intomainfrom
add-review-md
Mar 9, 2026
Merged

chore: add REVIEW.md, update AI review docs#8312
paulbalaji merged 3 commits intomainfrom
add-review-md

Conversation

@paulbalaji
Copy link
Copy Markdown
Collaborator

@paulbalaji paulbalaji commented Mar 9, 2026

Summary

  • Adds a REVIEW.md file to guide Claude Code's automated PR review feature
  • Defines what reviewers should always flag (security issues, type safety violations, missing tests)
  • Defines what to skip (formatting, style handled by linters)
  • Complements existing CLAUDE.md review guidelines with review-specific rules

Context

Claude Code now supports REVIEW.md files for review-specific guidance, separate from CLAUDE.md.

🤖 Generated with Claude Code


Note

Low Risk
Documentation/guideline-only changes with no runtime behavior impact; risk is limited to reviewers following the new guidance.

Overview
Adds a new top-level REVIEW.md containing consolidated, repo-specific code review guidelines (including a mandatory type-cast/any audit and testing/changeset expectations).

Updates the claude-review skill documentation to reference REVIEW.md instead of the previous .github/prompts/code-review.md guidance.

Written by Cursor Bugbot for commit 9e046b5. This will update automatically on new commits. Configure here.

@paulbalaji paulbalaji changed the title Add REVIEW.md for Claude Code automated reviews chore: add REVIEW.md, update AI review docs Mar 9, 2026
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Comment thread REVIEW.md
@paulbalaji paulbalaji marked this pull request as ready for review March 9, 2026 20:19
@paulbalaji paulbalaji added this pull request to the merge queue Mar 9, 2026
Merged via the queue into main with commit 7ec7c32 Mar 9, 2026
64 checks passed
@paulbalaji paulbalaji deleted the add-review-md branch March 9, 2026 20:23
@github-project-automation github-project-automation Bot moved this from In Review to Done in Hyperlane Tasks Mar 9, 2026
Copy link
Copy Markdown
Contributor

@claude claude Bot left a comment

Choose a reason for hiding this comment

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

LGTM, straightforward documentation change with no runtime impact.

Extended reasoning...

Overview

This PR modifies two documentation files: REVIEW.md (updated header from a prompt-style instruction to a proper markdown title, removed 3 trailing instruction lines) and .claude/skills/claude-review/SKILL.md (updated file path reference from .github/prompts/code-review.md to REVIEW.md). No code, configuration, or runtime behavior is changed.

Security risks

None. These are purely documentation/guideline files that instruct AI review tools. No code execution paths are affected.

Level of scrutiny

Minimal scrutiny needed. This is a low-risk documentation reorganization. The content of the review guidelines themselves is unchanged — only the file location and formatting wrapper changed. The cursor[bot] duplication concern was already marked as resolved in the PR timeline.

Other factors

The recent commit history on master (9e046b5 Refactor claude-review skill to use REVIEW.md, remove code-review.md) confirms the old .github/prompts/code-review.md file has been removed, so the SKILL.md path update is necessary and correct. No outstanding reviewer comments remain unaddressed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants