Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 1.46 KB

File metadata and controls

53 lines (41 loc) · 1.46 KB
name make-pr-easy-to-review
description 让当前 diff 或 PR 更容易审查。用户说 make this easy to review、整理 PR、写 reviewer notes、拆分说明、审查前清理提交信息/描述时使用。

Make PR Easy To Review

Use this skill to improve reviewability without changing product behavior.

Workflow

  1. Inspect context:
    • git status --short
    • git diff --stat
    • git diff --staged --stat
    • PR metadata with gh pr view only if a PR exists and the user asks about it.
  2. 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.
  3. Prefer non-code improvements first:
    • Concise TL;DR.
    • Changed-file map.
    • Risk notes.
    • Verification notes.
  4. If code cleanup is needed, use the deslop standard and keep behavior unchanged.

Guardrails

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

Output

Produce reviewer-ready notes:

## TL;DR
<one paragraph>

## Reviewer Entry Points
- <file>: <why it matters>

## Risk
- <risk or "Low">

## Verification
- <commands/results>