关于 pr
pr 是一项帮助撰写 PR 正文的技能,面向需要简洁说明变更、证据和合并风险的开发者。它根据内容选择伪代码、调用树、组件树、文件树、图表或 diff 等呈现方式。
主要功能
- 01提供 PR 正文结构模板
- 02按主题选择代码或图表视图
- 03用前后证据说明变更效果
- 04说明合并风险与影响范围
- 05要求简洁并采用领域术语
适用场景
- 01为功能变更撰写 PR 摘要
- 02展示运行时控制流或组件结构
- 03整理变更前后的测试或截图证据
- 04评估变更的回滚难度与影响范围
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ devcxl/ mattpocock-skills-zh --skill pr安装后在 Claude Code 中输入/pr确认已加载。
附带文件agents/openai.yamlCREDITS.md
详细介绍
来自项目 README写 PR body 时用这个模板:
## Summary(摘要)
<图表、diff 草图,或树>
## Evidence(证据)
- **Before:** <截图 / 输出 / 失败中的测试运行>
**After:** <截图 / 输出 / 通过了的测试运行>
## Merge Danger(合并风险)
**Door:** <单向门或双向门>
<可选:说明>
**Blast Radius:** <一个词的描述>
<可选:合并的潜在影响>
各章节
跳过所有开场白,行文保持简短。使用 GLOSSARY.md 里用户的领域语言。
Summary(摘要)
挑最小的、能把关键点讲清楚的视图。
- 逻辑或算法用伪代码展示:
on(save)
if content is unchanged
return cached result
write new content
return fresh result
- 运行时控制流用调用树展示:
submitForm
createSession
persistPrompt
launchAgent
navigateToSession
- UI 结构用组件树展示,包含真正重要的状态和模块边界:
<SessionPage> (apps/example/src/routes/session.tsx)
useSessionEvents()
<SessionToolbar>
<RunSkillButton> (packages/ui)
- 文件职责或大范围重构用浅文件树展示:
src/
├── commands/ # 解析用户动作
├── sessions/ # 掌管会话状态
└── transport/ # 发送 API 请求
- 组件交互、控制流或数据流用 Mermaid 展示:
sequenceDiagram
participant User
participant UI
participant Daemon
User->>UI: 选择命令
UI->>Daemon: 发送展开后的提示
Daemon-->>UI: 流式返回结果
- 当重点是"变了什么"、而周围形状已经存在时,用
diff。让 diff 的形状匹配主题。
组件变更:
<SessionPage>
useSessionEvents()
<SessionToolbar>
+ <RunSkillButton />
<SessionTimeline>
+ <SkillResultCard />
文件布局变更:
src/
├── commands/
+│ └── show-me.ts # 展开 slash 命令
├── sessions/
-└── transport.ts
+└── transport/
+ ├── client.ts
+ └── stream.ts
调用树或调用栈变更:
submitForm
createSession
persistPrompt
+ expandSkillMention
launchAgent
- navigateToSession
+ navigateToSession
+ subscribeToEvents
状态或控制流变更:
on(save)
- write content
+ if content is unchanged
+ return cached result
+ write new content
+ invalidate cache
- 当大部分内容都是新的、省略上下文会掩盖归属或顺序、或者用户需要一个可复制的目标形状时,展示完整代码块:
function expandSkill(command: string): string {
const skillName = command.slice(1);
return `use the ${skillName} skill`;
}
指引
把每个视图放在它所支撑的短文字旁边。只保留回答用户当前问题、或解决当前讨论点所需选项所必需的调用、文件、props、状态和边界。
这些视图你可能会用一个、用几个,但不太可能全都用上。用你的判断力,别把用户淹没。
Evidence(证据)
证明变更确实生效的具体证据。展示前后对比。
截图是 S 级,前提是环境已经搭好、且变更本身是视觉性的。
基于执行的证据是 A 级:测试结果、控制台输出。用伪代码展示那个先失败、后通过的具体测试。
Merge Danger(合并风险)
说明它是单向门还是双向门。双向门可以走回去,单向门不能。回滚代价低的 PR 风险更低。涉及破坏性操作或难以逆转的决策的变更,是单向门。
Blast radius(爆炸半径)是这个 PR 引入变更的潜在影响或波及范围。把所有可能性都考虑一遍。例如:布局偏移、对使用方的破坏、移动端响应性等。
评论
支持 Markdown