Make PR Easy to Review
Prepare a PR so a reviewer can quickly understand the intent, important files, and risk. The default goal is reviewability without behavior changes.
Workflow
- Resolve the target PR from the user-provided URL or current branch.
- Inspect commits, diff size, changed paths, generated files, and PR description.
- Identify reviewability issues: noisy commits, stale description, unrelated changes, mixed mechanical and logic changes, missing tests, or unclear reviewer entry points.
- Propose a plan before rewriting history or force-pushing.
- Apply safe improvements, then verify the tree or diff still matches the intended code.
History Cleanup
Only rewrite history when the user asks for it or agrees to the plan. Before rewriting:
gh pr view <PR> --json title,headRefName,baseRefName,state,commits
git fetch origin <headRefName> <baseRefName>
ORIGINAL_TREE=$(git rev-parse origin/<headRefName>^{tree})
Good commit groupings usually follow dependency order:
- Schema/storage or generated API definitions.
- Core logic.
- Wiring and integration.
- UI or surface behavior.
- Tests.
After rewriting, verify content identity:
echo "Original tree: $ORIGINAL_TREE"
echo "Current tree: $(git rev-parse HEAD^{tree})"
git diff origin/<headRefName> --stat
Do not push if the tree changed unintentionally.
Reviewer Guidance
When code behavior should stay untouched, prefer PR description and review notes:
- Add a TL;DR that matches the actual diff.
- Separate core files from generated or mechanical files.
- Call out risky behavior changes, migration order, rollout plan, and test coverage.
- Link issue trackers, dashboards, or design docs when they explain intent.
Guardrails
- Never hide meaningful behavior changes inside "cleanup".
- Do not bypass hooks unless the user explicitly asks.
- If the PR is too large to make reviewable with notes, recommend splitting instead of polishing around the problem.
1---
2name: make-pr-easy-to-review
3description: Prepare PRs for review by cleaning noisy history, improving PR descriptions, and adding reviewer guidance without changing code behavior. Use for "make this easy to review", "tidy this PR", "clean up commits", or "annotate the diff".
4---
5
6# Make PR Easy to Review
7
8Prepare a PR so a reviewer can quickly understand the intent, important files, and risk. The default goal is reviewability without behavior changes.
9
10## Workflow
11
121. Resolve the target PR from the user-provided URL or current branch.
132. Inspect commits, diff size, changed paths, generated files, and PR description.
143. Identify reviewability issues: noisy commits, stale description, unrelated changes, mixed mechanical and logic changes, missing tests, or unclear reviewer entry points.
154. Propose a plan before rewriting history or force-pushing.
165. Apply safe improvements, then verify the tree or diff still matches the intended code.
17
18## History Cleanup
19
20Only rewrite history when the user asks for it or agrees to the plan. Before rewriting:
21
22```bash
23gh pr view <PR> --json title,headRefName,baseRefName,state,commits
24git fetch origin <headRefName> <baseRefName>
25ORIGINAL_TREE=$(git rev-parse origin/<headRefName>^{tree})
26```
27
28Good commit groupings usually follow dependency order:
29
301. Schema/storage or generated API definitions.
312. Core logic.
323. Wiring and integration.
334. UI or surface behavior.
345. Tests.
35
36After rewriting, verify content identity:
37
38```bash
39echo "Original tree: $ORIGINAL_TREE"
40echo "Current tree: $(git rev-parse HEAD^{tree})"
41git diff origin/<headRefName> --stat
42```
43
44Do not push if the tree changed unintentionally.
45
46## Reviewer Guidance
47
48When code behavior should stay untouched, prefer PR description and review notes:
49
50- Add a TL;DR that matches the actual diff.
51- Separate core files from generated or mechanical files.
52- Call out risky behavior changes, migration order, rollout plan, and test coverage.
53- Link issue trackers, dashboards, or design docs when they explain intent.
54
55## Guardrails
56
57- Never hide meaningful behavior changes inside "cleanup".
58- Do not bypass hooks unless the user explicitly asks.
59- If the PR is too large to make reviewable with notes, recommend splitting instead of polishing around the problem.
majiayu000