chore: polish PR review skills

This commit is contained in:
Gustavo Madeira Santana
2026-02-18 22:24:38 -05:00
parent 3d4ef56044
commit b228c06bbd
4 changed files with 63 additions and 8 deletions

View File

@@ -110,7 +110,7 @@ Before any substantive review or prep work, **always rebase the PR branch onto c
- During `prepare-pr`, use concise, action-oriented subjects **without** PR numbers or thanks; reserve `(#<PR>) thanks @<pr-author>` for the final merge/squash commit.
- Group related changes; avoid bundling unrelated refactors.
- Changelog workflow: keep the latest released version at the top (no `Unreleased`); after publishing, bump the version and start a new top section.
- When working on a PR: add a changelog entry with the PR number and thank the contributor (mandatory in this workflow).
- When working on a PR: add a changelog entry line with the PR number `(#<PR>)` and `thanks @<pr-author>` when author metadata is available (mandatory in this workflow).
- When working on an issue: reference the issue in the changelog entry.
- In this workflow, changelog is always required even for internal/test-only changes.

View File

@@ -41,11 +41,12 @@ scripts/pr-merge <PR>
scripts/pr-merge run <PR>
```
3. Ensure output reports:
3. Capture and report these values in a human-readable summary (not raw `key=value` lines):
- `merge_sha=<sha>`
- `merge_author_email=<email>`
- `comment_url=<url>`
- Merge commit SHA
- Merge author email
- Merge completion comment URL
- PR URL
## Steps
@@ -97,3 +98,4 @@ Cleanup is handled by `run` after merge success.
- End in `MERGED`, never `CLOSED`.
- Cleanup only after confirmed merge.
- In final chat output, use labeled lines or bullets; do not paste raw wrapper diagnostics unless debugging.

View File

@@ -74,6 +74,11 @@ jq -r '.changelog' .local/review.json
jq -r '.docs' .local/review.json
```
Changelog gate requirement:
- `CHANGELOG.md` must include a newly added changelog entry line.
- When PR author metadata is available, that same changelog entry line must include `(#<PR>) thanks @<pr-author>`.
4. Commit scoped changes
Use concise, action-oriented subject lines without PR numbers/thanks. The final merge/squash commit is the only place we include PR numbers and contributor thanks.