SuperAPI AI 工具集

pr

编程与开发

查看项目

更新于 11-04 04:19

技能介绍

用途

该技能用于撰写 PR(Pull Request)正文。以一个 prompt 或简要命名该技能即为调用方式。

主要能力

技能提供一个按固定顺序组织的 PR 正文模板,包含四个部分:

Summary(摘要)

选择最小的视图来清晰表达关键点,可使用伪代码、调用树、组件树、浅层文件树、Mermaid 图或 diff。

各类视图的适用场景:

  • 逻辑或算法用伪代码展示;
  • 运行时控制流用调用树展示;
  • UI 结构用组件树展示,包含重要的 state 与模块边界;
  • 文件职责或大范围重构用浅层文件树展示;
  • 组件交互、控制流或数据流用 Mermaid 展示;
  • 当重点在于“变化内容”且周围结构已存在时使用 diff,diff 的形态应与主题匹配(组件变更、文件布局变更、调用树变更、状态或控制流变更各有示例)。

当大部分内容都是新的、省略上下文会隐藏归属或顺序、或用户需要一个可复制的目标形态时,展示完整代码块。每个可视化视图应紧邻其支持的简短文字,只保留回答问题或讨论点所需的调用、文件、props、状态和边界,避免信息过载。

Evidence(证据)

展示变更有效的具体证据,需给出变更前后的对比。

  • 截图属于 S 级证据:当环境支持且变更是视觉性的时使用。截图应存放在名为 pr-assets/<topic> 的孤儿分支上,使其不进入默认分支历史;每张图片通过完整 commit SHA 链接;永不删除该资源分支,在清理分支时保留 pr-assets/*,以便已合并的 PR 保留其图片。
  • 基于执行的证据属于 A 级:测试结果、控制台输出。用伪代码展示现在失败、修复后通过的确切测试。
  • 列出在最终 commit 上运行的所有检查及其结果,并说明任何必需检查未运行的原因。

Merge Danger(合并风险)

描述该变更属于单向门还是双向门。双向门可以回退,单向门不能。容易回滚的 PR 风险较低;涉及破坏性操作或难以逆转决策的变更属于单向门。

Blast Radius(影响范围)指本 PR 引入变更的潜在影响或范围,需考虑所有可能性,例如布局偏移、对使用者的破坏、移动端响应式等。

在此说明变更的相关限制:哪些内容未被完成、未验证或不受支持。对于破坏性变更,在其子章节中解释影响与迁移方式。

Related issue(关联问题)

链接该变更所处理的 issue。当 PR 完成该 issue 时使用关闭引用,如 Closes #123;当只完成部分工作时使用非关闭引用,如 Part of #123。对于没有 issue 的工作,写 Direct change: 后跟原因。

使用方式

使用该模板撰写 PR 正文,保持各章节顺序不变。其他材料(如范围、影响、迁移)应放入其所属章节的子章节中。跳过所有前言,保持行文简短,使用 GLOSSARY.md 中用户的领域语言。

路径相对于仓库根目录。GLOSSARY.md 是用户的领域语言;当它缺失时,使用代码和其 issue 中所用的词汇。

限制

技能资料未提供其他功能、平台支持或收费信息。