这是一个专注于编写 PR 正文的模板型技能。它的核心用途是:当你需要为 Pull Request 撰写描述正文时,按此模板组织内容。
用途
当需要撰写 PR body 时使用本模板。模板要求跳过所有开场白,保持文字简洁,并使用用户在 GLOSSARY.md 中定义的领域语言。
主要结构
模板包含三个必需部分:Summary(摘要)、Evidence(证据)、Merge Danger(合并风险)。
Summary
选择能说清关键点的最小视图。可用的表达形式包括:
- 用伪代码展示逻辑或算法;
- 用调用树展示运行时控制流;
- 用组件树展示 UI 结构,包含相关的状态与模块边界;
- 用浅层文件树展示文件职责或大范围重构;
- 用 Mermaid 展示组件交互、控制流或数据流;
- 当重点是变更内容且周边结构已存在时使用 diff。
模板对 diff 给出了多种示例:组件变更、文件布局变更、调用树或调用栈变更、状态或控制流变更。
当大部分内容都是新增、省略上下文会隐藏归属或顺序、或用户需要一个可复制的目标形态时,展示完整代码块。
模板建议把每个可视化内容放在它所支撑的简短文字旁边,只保留回答问题或推进讨论点所需的调用、文件、属性、状态和边界。可以使用其中一种或多种表达方式,但不太可能全部用上,需要自行判断,避免信息过载。
Evidence
展示变更有效的具体证据,给出前后对比。截图是最高优先级,适用于环境已准备好且变更是视觉性的情况。基于执行的证据属于次高优先级,例如测试结果、控制台输出。展示现在失败、现在通过的精确测试,使用伪代码。
Merge Danger
描述这是一扇单向门还是双向门。双向门可以走回去,单向门不行。回滚成本低的 PR 风险更低。涉及破坏性操作或难以逆转决策的变更是单向门。
影响范围(Blast Radius)指本 PR 引入变更的潜在影响或范围,需考虑所有可能性,例如布局偏移、对使用方造成破坏、移动端响应性等,用一个词描述。
使用方式
将模板作为 PR 正文的写作框架,按 Summary、Evidence、Merge Danger 的顺序填充内容。
适用场景
适用于任何需要撰写 PR 描述的代码开发工作流。
限制
资料未提供该技能的具体安装方式、收费、平台支持范围等信息,暂未提供。