关于 pr
用于依据项目现有记录撰写便于审阅的 PR 正文,组织变更、证据与可逆性,并避免加入未经证实的说法。
主要功能
- 01一句话概述变更
- 02匹配变更类型的图示
- 03前后验证证据
- 04回滚方式与影响范围
- 05关联证据和 ADR
适用场景
- 01实现完成后撰写 PR 正文
- 02向审阅者呈现已验证的变更
- 03说明回滚方式和变更影响
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ yeachan-heo/ oh-my-claudecode --skill pr安装后在 Claude Code 中输入/pr确认已加载。
详细介绍
PR 正文
工作经审核后合并时,PR 正文是会话之外的审阅者唯一会阅读的材料。所需内容已存在于过程记录中——此技能会将其整理出来,不添加任何尚未确认的信息。摘要配图规范受到 show-me 的启发(已在 frontmatter 中致谢)。
模板
## Summary
<one-line claim, then the smallest visual that proves it>
## Evidence
- **Before:** <output / failing check>
**After:** <output / passing check>
## Reversibility
<Rollback: cheap via <mechanism> | expensive because <reason>>
<Blast radius: one line>
章节
摘要
用一句话说明变更,然后展示最能说明问题的精简视图。根据变更选择合适的视觉形式:
- 逻辑或算法 → 伪代码
- 运行时控制流 → 调用树
- UI 结构 → 组件树
- 文件职责或大范围重构 → 浅层文件树
- 组件交互或数据流 → Mermaid 图
- 变更本身 → 按变更形式组织的差异(组件、布局、调用树或状态机)
仅当大部分内容都是新增的、省略上下文会掩盖归属,或审阅者需要可复制的目标结构时,才展示完整代码块。通常一种视觉形式就足够;不要把所有形式都用上。
证据
使用 verify 协议的输出——BUILD、TEST、LINT、FUNCTIONALITY 证据,并沿用新鲜度规则。提供前后对照:引用输出本身,准确展示此前失败、现在通过的检查。变更涉及视觉效果时,优先使用截图;qa-tester 可以驱动运行时来获取截图。不要在此处重新收集证据,也不要声称 verify 流程未提供的证据。
可逆性
针对差异本身执行 ADR 测试——launch 对决策采用的同样三个问题:难以撤销?脱离上下文会令人意外?是否源于真实的权衡?如果三个问题的答案都是否定的,就是低成本回滚:说明回滚机制(撤销合并、切换标志)。只要有一个答案为是,就是高成本回滚:说明原因。先判断这是一扇哪种门:双向门(撤销成本低且寻常)无需繁琐说明,只需指出撤销方式;单向门则要明确说明,并指出导致此步骤不可逆的原因。如果变更实施或涉及某项 ADR,请附上链接。最后用一行说明影响范围——此变更还可能影响什么。
语言
存在术语表时,术语取自 GLOSSARY.md(尚未迁移的旧项目目录沿用 CONTEXT.md)。PR 会在会话之外阅读;术语表是读者与 PR 共享的唯一词汇依据。
触发条件
- 启动 Phase 5,且平台通过 PR 进行审阅时:完成报告会附上由此技能起草的 PR 正文。
- 任何创建或实质性更新 PR 的会话。
输出
- 可直接粘贴的 PR 正文
- 所依据的过程记录指引(verify 证据、ADR、规范)