用途
本技能用于撰写拉取请求(PR)正文。当需要为代码变更编写 PR 描述时,可直接套用该模板。
主要能力
模板将 PR 正文划分为三个区块:
Summary(摘要):选择最小但能清晰说明关键点的视图。可用的呈现形式包括:
- 用伪代码展示逻辑或算法;
- 用调用树展示运行时控制流;
- 用组件树展示 UI 结构,并标注关键的状态与模块边界;
- 用浅层文件树展示文件职责或大范围重构;
- 用 Mermaid 序列图展示组件交互、控制流或数据流;
- 用 diff 展示具体变更,diff 形式需与主题匹配(组件变更、文件布局变更、调用树变更、状态或控制流变更)。
当大部分内容为新增、省略上下文会掩盖归属或顺序、或用户需要可复制的目标形态时,应展示完整代码块。
Evidence(证据):提供变更有效的具体证据,展示改动前与改动后。截图属于最高等级证据(适用于环境已就绪且变更为视觉类的情况);基于执行的证据次之,如测试结果、控制台输出,并用伪代码展示当前失败与通过的测试。
Merge Danger(合并风险):说明该变更是单向门还是双向门。双向门可以走回,单向门不行;回滚成本低的 PR 风险更低,涉及破坏性操作或难以逆转的决策属于单向门。同时用一词描述爆炸半径,即该 PR 引入变更的潜在影响或范围,如布局偏移、对使用方造成破坏、移动端响应性等。
使用方式
按模板结构填写各区块。跳过所有前言,保持文字简短,使用来自 GLOSSARY.md 的用户领域语言。每个可视化图应紧邻其支持的简短文字。仅保留回答当前问题或讨论点所需的调用、文件、属性、状态与边界。可以选用一种或多种可视化形式,但不宜全部使用,以免使读者过载。
适用场景
适用于任何需要编写 PR 正文的代码协作场景,尤其适合需要清晰传达变更内容、验证证据与合并风险的团队评审流程。
限制
该模板侧重正文结构与呈现方式,不涉及 PR 的创建、提交或自动化流程。具体项目语言与术语需参考 GLOSSARY.md,资料未提供该文件的具体内容。