---
id: gh-pr
name: "pr"
url: https://skills.yangsir.net/skill/gh-pr
author: mattpocock
domain: ai-project-management-collaboration
tags: ["pull-request", "code-review", "documentation", "git-workflow", "collaboration"]
install_count: 161300
rating: 4.80 (120 reviews)
github: https://github.com/mattpocock/skills/tree/main/skills/in-progress/pr
---

# pr

> 此技能用于撰写结构清晰的 PR 描述，按 Summary／Evidence／Merge Danger 三段式模板组织内容。它会挑选调用树、组件树、Mermaid 时序图或 diff 等最小可视化讲清改动意图，要求给出改动前后的可验证证据，并评估回滚难度与影响范围，让评审者几分钟内看懂这次合并的风险。

**Stats**: 161,300 installs · 4.8/5 (120 reviews)

## Before / After 对比

### 撰写 PR 描述耗时对比

**Before**:

开发者写完代码后对着空白描述框反复删改，凭感觉罗列几条改动要点，往往拖到下班前才补完，还漏掉了关键影响范围。

**After**:

此技能按 Summary／Evidence／Merge Danger 三段式直接生成骨架，并提示该配哪种图与前后证据，内容一次成稿，不再反复返工。

| Metric | Before | After | Change |
|---|---|---|---|
| 撰写 PR 描述耗时 | 25分钟 | 6分钟 | -76% |

### 评审往返轮次对比

**Before**:

描述只写「修复一些问题」，评审者看不懂意图，只能逐条留言追问改动原因、影响面和如何回滚，来回拉扯好几轮。

**After**:

该 Skill 强制给出改动前后证据、单向门或双向门判断与影响范围，评审者一次读完整意，直接进入代码层面讨论。

| Metric | Before | After | Change |
|---|---|---|---|
| 评审往返轮次 | 4轮 | 1轮 | -75% |

### 回滚风险漏判率对比

**Before**:

合并前没人明确说明这是破坏性变更还是可轻易回滚的改动，风险判断全靠口头沟通，容易遗漏消费者侧影响。

**After**:

此技能要求显式标注单向门／双向门与影响范围，风险在合并前被写出，遗漏破坏性变更的情况明显减少。

| Metric | Before | After | Change |
|---|---|---|---|
| 回滚风险漏判率 | 35% | 8% | -77% |

## Readme

Use this template for writing the PR body:

```markdown
## Summary

<diagram, diff-sketch, or tree>

## Evidence

- **Before:** <screenshot/output/failing test run>
  **After:** <screenshot/output/passing test run>

## Merge Danger

**Door:** <one-way or two-way>

<optional: description>

**Blast Radius:** <one-word description>

<optional: potential ramifications of merge>
```

## Sections

Skip all preambles and keep prose brief. Use the user's domain language from `CONTEXT.md`.

### Summary

Pick the smallest view that makes the key point clear.

- Show logic or an algorithm as pseudocode:

```text
on(save)
  if content is unchanged
    return cached result
  write new content
  return fresh result
```

- Show runtime control flow as a call tree:

```text
submitForm
  createSession
    persistPrompt
    launchAgent
  navigateToSession
```

- Show UI structure as a component tree, including state and module boundaries that matter:

```tsx
<SessionPage>(apps / example / src / routes / session.tsx);
useSessionEvents() < SessionToolbar > <RunSkillButton>(packages / ui);
```

- Show file responsibility or a broad refactor as a shallow file tree:

```text
src/
├── commands/       # parses user actions
├── sessions/       # owns session state
└── transport/      # sends API requests
```

- Show component interaction, control flow, or data flow with Mermaid:

```mermaid
sequenceDiagram
    participant User
    participant UI
    participant Daemon
    User->>UI: choose command
    UI->>Daemon: send expanded prompt
    Daemon-->>UI: stream result
```

- Use `diff` when the point is what changes and the surrounding shape already exists. Match the diff shape to the topic.

For a component change:

```diff
 <SessionPage>
   useSessionEvents()
   <SessionToolbar>
+    <RunSkillButton />
   <SessionTimeline>
+    <SkillResultCard />
```

For a file-layout change:

```diff
 src/
 ├── commands/
+│   └── show-me.ts       # expands the slash command
 ├── sessions/
-└── transport.ts
+└── transport/
+    ├── client.ts
+    └── stream.ts
```

For a call-tree or call-stack change:

```diff
 submitForm
   createSession
     persistPrompt
+    expandSkillMention
     launchAgent
-  navigateToSession
+  navigateToSession
+    subscribeToEvents
```

For a state or control-flow change:

```diff
 on(save)
-  write content
+  if content is unchanged
+    return cached result
+  write new content
+  invalidate cache
```

- Show the whole block when most of it is new, when omitted context would hide ownership or order, or when the user needs a copyable target shape:

```ts
function expandSkill(command: string): string {
  const skillName = command.slice(1);
  return `use the ${skillName} skill`;
}
```

#### Guidance

Place each visual next to the short text it supports. Keep only the calls, files, props, states, and boundaries needed to answer the user's current question or the options to resolve the current discussion point.

You may use one of these, you may use several, it is unlikely you will use all of them. Use your judgement and don't overwhelm the user.

### Evidence

Concrete evidence that the change works. Show a before and after.

Screenshots are S-tier - when the environment is set up for it and the change is visual.

Execution-based evidence is A-tier. Test results, console output. Show the exact test that now fails and passes, using pseudocode.

### Merge Danger

Describe whether it's a one-way or two-way door. You can walk back through two-way doors, but not one-way doors. A PR that is cheap to roll back is lower risk. Changes that involve destructive actions or hard-to-reverse decisions are one-way doors.

The blast radius is the potential impact or scope of the changes introduced by this PR. Consider all possibilities. Examples are layout shift, breakages for consumers, mobile responsiveness, etc.


---
*Source: https://skills.yangsir.net/skill/gh-pr*
*Markdown mirror: https://skills.yangsir.net/api/skill/gh-pr/markdown*