SuperAPI AI 工具集

pr

编程与开发

查看项目

更新于 10-20 16:09

技能介绍

本技能用于指导撰写 Pull Request(PR)正文,提供固定模板与写作建议。

用途:当需要编写 PR 描述时使用该模板,帮助作者以简洁、结构化的方式说明改动内容、验证证据和合并风险。

模板结构:

  1. Summary(摘要):放置图示、diff 草图或树状结构。
  2. Evidence(证据):提供改动前后的截图、输出或测试运行结果对比。
  3. Merge Danger(合并风险):标注 Door(单向门或双向门)与 Blast Radius(影响范围,用一词描述),可选补充潜在后果。

主要能力与写作建议:

  • 摘要部分应选择能清楚表达关键点的最小视图。可根据场景使用伪代码展示逻辑或算法、调用树展示运行时控制流、组件树展示 UI 结构、浅层文件树展示文件职责或大范围重构、Mermaid 序列图展示组件交互/控制流/数据流,以及 diff 展示具体变更。
  • 当大部分内容为新增、省略上下文会隐藏归属或顺序、或用户需要可复制的目标形态时,展示完整代码块。
  • 每个视觉元素应紧挨其支持的简短文字,仅保留回答当前问题所需的调用、文件、属性、状态和边界,避免信息过载。
  • 证据部分要求提供具体证据证明改动有效,展示改动前后对比;截图在环境支持且改动为视觉性时最佳,基于执行的证据(测试结果、控制台输出)次之,并用伪代码展示现在失败与现在通过的具体测试。
  • 合并风险部分说明改动是单向门还是双向门:可回退的双向门风险较低,涉及破坏性操作或难以逆转的决策属于单向门。影响范围需考虑所有可能性,如布局偏移、对使用方的破坏、移动端响应性等。

使用方式:按模板填写三个阶段,跳过所有前言,保持文字简洁,使用用户领域语言(来自 GLOSSARY.md)。

适用场景:编写 PR 正文、在代码评审前说明改动意图与风险、需要结构化呈现技术变更的场合。

限制:该技能仅提供模板与写作指导,不涉及自动化生成、代码执行或平台集成;相关工具链支持、具体平台行为暂未提供。