| name | make-pr-easy-to-review |
|---|---|
| description | 让当前 diff 或 PR 更容易审查。用户说 make this easy to review、整理 PR、写 reviewer notes、拆分说明、审查前清理提交信息/描述时使用。 |
Use this skill to improve reviewability without changing product behavior.
- Inspect context:
git status --shortgit diff --statgit diff --staged --stat- PR metadata with
gh pr viewonly if a PR exists and the user asks about it.
- Identify reviewability issues:
- Mixed mechanical and behavioral edits.
- Stale or missing PR description.
- Generated files mixed with hand-written files.
- Large files where the reviewer needs an entry point.
- Missing test notes.
- Prefer non-code improvements first:
- Concise TL;DR.
- Changed-file map.
- Risk notes.
- Verification notes.
- If code cleanup is needed, use the
deslopstandard and keep behavior unchanged.
- Do not rewrite history, squash commits, force-push, push, or open PRs without explicit approval.
- Do not hide behavior changes under "cleanup".
- Do not edit unrelated files.
- If the PR is too large to make reviewable with notes, recommend splitting it instead of polishing around the problem.
Produce reviewer-ready notes:
## TL;DR
<one paragraph>
## Reviewer Entry Points
- <file>: <why it matters>
## Risk
- <risk or "Low">
## Verification
- <commands/results>