make-pr-easy-to-review

Featured

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".

Code & Development 333 stars 40 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 88/100

Stars 20%
84
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
99
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 1. Resolve the target PR from the user-provided URL or current branch. 2. Inspect commits, diff size, changed paths, generated files, and PR description. 3. Identify reviewability issues: noisy commits, stale description, unrelated changes, mixed mechanical and logic changes, missing tests, or unclear reviewer entry points. 4. Propose a plan before rewriting history or force-pushing. 5. 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: ```bash 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: 1. Schema/storage or generated API definitions. 2. Core logic. 3. Wiring and integration. 4. UI or surface behavior. 5. Tests. After rewriting, verify content identity: ```bash 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 m...

Details

Author
michael-denyer
Repository
michael-denyer/pstack-claude
Created
3 months ago
Last Updated
2 days ago
Language
TypeScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category