Skip to content

fix(github-pr-review): add explicit guidance on when to use APPROVE event #269

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xingyaoww wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −2
Open

fix(github-pr-review): add explicit guidance on when to use APPROVE event #269

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions skills/github-pr-review/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,22 @@ gh api -X POST repos/{owner}/{repo}/pulls/{pr_number}/reviews --input /tmp/revie
| Parameter | Description |
|-----------|-------------|
| `commit_id` | Commit SHA to comment on (use `git rev-parse HEAD`) |
| `event` | `COMMENT`, `APPROVE`, or `REQUEST_CHANGES` |
| `event` | `APPROVE`, `COMMENT`, or `REQUEST_CHANGES` (see below) |
| `path` | File path as shown in the diff |
| `line` | Line number in the NEW version (right side of diff) |
| `side` | `RIGHT` for new/added lines, `LEFT` for deleted lines |
| `body` | Comment text with priority label |

### Choosing the `event` Value

| Event | When to use |
|-------|-------------|
| `APPROVE` | No issues found, or only 🟡 suggestions that are non-blocking |
| `COMMENT` | You have 🟠 Important feedback but it's not a hard blocker |
| `REQUEST_CHANGES` | There are 🔴 Critical issues that **must** be fixed before merge |

**Default to `APPROVE`** when the code is correct and merge-ready. Use `COMMENT` or `REQUEST_CHANGES` only when there are actionable issues that warrant it.

### Multi-Line Comments

For comments spanning multiple lines, add `start_line` to specify the range:
Expand Down Expand Up @@ -145,4 +155,4 @@ curl -X POST \
5. Do NOT post comments for code that is acceptable — only comment when action is needed
6. Use suggestion syntax for concrete code changes
7. Keep the review body brief (details go in inline comments)
8. If no issues: post a short approval message with no inline comments
8. If no issues: use `"event": "APPROVE"` with a short approval message and no inline comments
Loading