zhanj/claude-code
1
0
Fork 0
mirror of https://github.com/anthropics/claude-code.git synced 2026-05-21 02:52:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refine inline comment formatting: no Bug prefix, summary first, limit suggestion size

Browse Source
This commit is contained in:
Franklin Volcic
2025-12-17 15:27:37 -08:00
parent 2a61cb364c
commit 1ed82e6af0
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
plugins/code-review/commands/code-review.md
View File

@@ -52,23 +52,26 @@ Note: Still review Claude generated PR's.
6. Filter out any issues that were not validated in step 5. This step will give us our list of high signal issues for our review. 6. Filter out any issues that were not validated in step 5. This step will give us our list of high signal issues for our review.
7. Finally, output the review. 7. Post summary comment FIRST using `gh pr comment` (if `--comment` argument is provided):
- If the `--comment` argument is provided, post the review as a comment on the pull request using `gh pr comment` - "## Code review" header
- Otherwise (default), output the review directly to the terminal for local viewing - Total number of issues found
- Brief one-line summary of each issue (no "Bug:" prefix)
- Or if no issues: "No issues found. Checked for bugs and CLAUDE.md compliance."
When writing your comment, follow these guidelines: When writing your comment, follow these guidelines:
a. Keep your output brief a. Keep your output brief
b. Avoid emojis b. Avoid emojis
c. Link and cite relevant code, files, and URLs for each issue c. Link and cite relevant code, files, and URLs for each issue
d. When citing CLAUDE.md violations, you MUST quote the exact text from CLAUDE.md that is being violated (e.g., CLAUDE.md says: "Use snake_case for variable names") d. When citing CLAUDE.md violations, you MUST quote the exact text from CLAUDE.md that is being violated (e.g., CLAUDE.md says: "Use snake_case for variable names")
8. Post inline comments for each issue using `mcp__github_inline_comment__create_inline_comment`: 8. THEN post inline comments for each issue using `mcp__github_inline_comment__create_inline_comment`:
- `path`: the file path - `path`: the file path
- `line` (and `startLine` for ranges): select the buggy lines so the user sees them - `line` (and `startLine` for ranges): select the buggy lines so the user sees them
- `body`: Brief description of the issue. For small fixes (1-3 lines), include a committable suggestion: - `body`: Brief description of the issue (no "Bug:" prefix). For small fixes (1-3 lines changed), include a committable suggestion:
```suggestion ```suggestion
corrected code here corrected code here
``` ```
For larger fixes, describe the solution approach instead of providing code. For larger fixes (4+ lines or structural changes), do NOT use suggestion blocks. Instead, describe at a high level how to fix the issue (e.g., "Consider adding a null check before accessing this property" or "This condition should use === instead of =").
**IMPORTANT: Only post ONE comment per unique issue. Do not post duplicate comments.** **IMPORTANT: Only post ONE comment per unique issue. Do not post duplicate comments.**