110 lines
3.8 KiB
Markdown
110 lines
3.8 KiB
Markdown
---
|
|
name: review-pr
|
|
description: Review a pull request diff and write structured feedback to review.json for the workflow to publish. Use when reviewing a checked-out PR from local artifacts like pr_diff.txt and pr_description.txt and producing machine-readable review output instead of posting directly to GitHub.
|
|
---
|
|
|
|
# Review PR Skill
|
|
|
|
Review the current pull request and write the output to `review.json`.
|
|
|
|
## Context
|
|
|
|
- The working directory is the PR branch checkout.
|
|
- The workflow provides an annotated diff in `pr_diff.txt`.
|
|
- The workflow provides the PR description in `pr_description.txt`.
|
|
- Focus on files and lines changed by this PR.
|
|
- Do not post comments or reviews to GitHub directly.
|
|
|
|
## Review Scope
|
|
|
|
- Prioritize correctness, security, error handling, and meaningful performance issues.
|
|
- Include style or nit comments only when you can provide a concrete suggestion block.
|
|
- If a concern involves untouched code, mention it in the summary instead of an inline comment.
|
|
- Do not suggest adding test cases that only vary constructor inputs or struct fields when the existing test already covers the meaningful behavior. Only suggest new tests when they exercise a distinct code path or edge case.
|
|
- When a PR is clearly a V0 or initial implementation, frame robustness suggestions (timeouts, retries, lifecycle management) as optional future work rather than blocking concerns, unless they risk correctness, security, or data loss.
|
|
|
|
## Diff Line Annotations
|
|
|
|
The diff file uses these prefixes:
|
|
|
|
- `[OLD:n]` for deleted lines on the old side. Use `"LEFT"`.
|
|
- `[NEW:n]` for added lines on the new side. Use `"RIGHT"`.
|
|
- `[OLD:n,NEW:m]` for unchanged context. Use `"RIGHT"` with line `m`.
|
|
|
|
## Comment Requirements
|
|
|
|
Every comment body must start with one of these labels:
|
|
|
|
- `🚨 [CRITICAL]` for bugs, security issues, crashes, or data loss.
|
|
- `⚠️ [IMPORTANT]` for logic problems, edge cases, or missing error handling.
|
|
- `💡 [SUGGESTION]` for worthwhile improvements or better patterns.
|
|
- `🧹 [NIT]` for cleanup only when the comment includes a suggestion block.
|
|
|
|
Write comments with these constraints:
|
|
|
|
- Be concise, direct, and actionable.
|
|
- Do not add compliments or hedging.
|
|
- Prefer single-line comments.
|
|
- Keep ranges to at most 10 lines.
|
|
- Restrict inline comments to valid changed lines in this PR.
|
|
|
|
## Suggestion Blocks
|
|
|
|
When proposing a code change, use:
|
|
|
|
```suggestion
|
|
<replacement code here>
|
|
```
|
|
|
|
Rules:
|
|
|
|
- Match the exact indentation of the original file.
|
|
- Include only replacement code.
|
|
- For multi-line suggestions, set `start_line` to the first line and `line` to the last line.
|
|
|
|
## Output Format
|
|
|
|
Create `review.json` with this shape:
|
|
|
|
```json
|
|
{
|
|
"summary": "## Overview\n...\n\n## Concerns\n- ...\n\n## Verdict\nFound: 1 critical, 2 important, 3 suggestions\n\n**Request changes**",
|
|
"comments": [
|
|
{
|
|
"path": "path/to/file",
|
|
"line": 42,
|
|
"side": "RIGHT",
|
|
"start_line": 40,
|
|
"body": "⚠️ [IMPORTANT] Short explanation\n\n```suggestion\nreplacement\n```"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
Field rules:
|
|
|
|
- `path` must be relative to the repository root.
|
|
- `line` is required and must target the correct side.
|
|
- `start_line` is optional and only for multi-line ranges.
|
|
- `side` must be `"LEFT"` or `"RIGHT"`.
|
|
|
|
## Summary Requirements
|
|
|
|
The `summary` must include:
|
|
|
|
- A high-level overview of the PR.
|
|
- Important concerns and any untouched-code concerns that could not be commented inline.
|
|
- Issue counts in the format `Found: X critical, Y important, Z suggestions`.
|
|
- A final recommendation of `Approve`, `Approve with nits`, or `Request changes`.
|
|
|
|
## Final Checks
|
|
|
|
Before finishing:
|
|
|
|
- Validate `review.json` with `jq`.
|
|
- Fix invalid JSON if validation fails.
|
|
- Confirm line numbers match the annotated diff.
|
|
- Do not run `gh pr review`, `gh pr comment`, `gh api`, or any other command that posts to GitHub.
|
|
|
|
Your only output is the final `review.json`.
|