From 9b08c1010b0992b87389d19503e20a13c6cd93a9 Mon Sep 17 00:00:00 2001 From: Franklin Volcic Date: Wed, 7 Jan 2026 18:40:14 -0500 Subject: [PATCH] refactor(code-review): simplify inline comment instructions and clarify issue criteria 1. Remove redundant tool parameter descriptions - MCP tool is source of truth 2. Clarify what issues to flag: - Compile/parse errors (syntax, types, imports, references) - Clear logic errors that produce wrong results regardless of inputs - CLAUDE.md violations 3. Clarify what NOT to flag: - Code style or quality concerns - Issues that depend on specific inputs or state - Subjective suggestions --- plugins/code-review/commands/code-review.md | 39 ++++++++------------- 1 file changed, 15 insertions(+), 24 deletions(-) diff --git a/plugins/code-review/commands/code-review.md b/plugins/code-review/commands/code-review.md index 51d1d779..86c7823c 100644 --- a/plugins/code-review/commands/code-review.md +++ b/plugins/code-review/commands/code-review.md @@ -5,6 +5,10 @@ description: Code review a pull request Provide a code review for the given pull request. +**Agent assumptions (applies to all agents and subagents):** +- All tools are functional and will work without error. Do not test tools or make exploratory calls. +- Only call a tool if it is required to complete the task. Every tool call should have a clear purpose. + To do this, follow these steps precisely: 1. Launch a haiku agent to check if any of the following are true: @@ -34,15 +38,15 @@ Note: Still review Claude generated PR's. Agent 4: Opus bug agent (parallel subagent with agent 3) Look for problems that exist in the introduced code. This could be security issues, incorrect logic, etc. Only look for issues that fall within the changed code. - **CRITICAL: We only want HIGH SIGNAL issues.** This means: - - Objective bugs that will cause incorrect behavior at runtime + **CRITICAL: We only want HIGH SIGNAL issues.** Flag issues where: + - The code will fail to compile or parse (syntax errors, type errors, missing imports, unresolved references) + - The code will definitely produce wrong results regardless of inputs (clear logic errors) - Clear, unambiguous CLAUDE.md violations where you can quote the exact rule being broken - We do NOT want: - - Subjective concerns or "suggestions" - - Style preferences not explicitly required by CLAUDE.md - - Potential issues that "might" be problems - - Anything requiring interpretation or judgment calls + Do NOT flag: + - Code style or quality concerns + - Potential issues that depend on specific inputs or state + - Subjective suggestions or improvements If you are not certain an issue is real, do not flag it. False positives erode trust and waste reviewer time. @@ -57,23 +61,10 @@ Note: Still review Claude generated PR's. If NO issues were found, post a summary comment using `gh pr comment` (if `--comment` argument is provided): "No issues found. Checked for bugs and CLAUDE.md compliance." -8. Post inline comments for each issue using `mcp__github_inline_comment__create_inline_comment`: - - `path`: the file path - - `line` (and `startLine` for ranges): select the buggy lines so the user sees them - - `body`: Brief description of the issue (no "Bug:" prefix). For small fixes (up to 5 lines changed), include a committable suggestion: - ```suggestion - corrected code here - ``` - - **Suggestions must be COMPLETE.** If a fix requires additional changes elsewhere (e.g., renaming a variable requires updating all usages), do NOT use a suggestion block. The author should be able to click "Commit suggestion" and have a working fix - no followup work required. - - For larger fixes (6+ lines, structural changes, or changes spanning multiple locations), do NOT use suggestion blocks. Instead: - 1. Describe what the issue is - 2. Explain the suggested fix at a high level - 3. Include a copyable prompt for Claude Code that the user can use to fix the issue, formatted as: - ``` - Fix [file:line]: [brief description of issue and suggested fix] - ``` +8. Post inline comments for each issue using `mcp__github_inline_comment__create_inline_comment`. For each comment: + - Provide a brief description of the issue + - For small, self-contained fixes, include a committable suggestion block + - For larger fixes (6+ lines, structural changes, or changes spanning multiple locations), describe the issue and suggested fix without a suggestion block **IMPORTANT: Only post ONE comment per unique issue. Do not post duplicate comments.**