SuperAPI AI 工具集

pr

编程与开发

查看项目

更新于 10-18 16:13

技能介绍

该技能用于在撰写 PR 正文时提供模板与写作规范,资料未提供安装方式或运行环境要求。

用途

当需要编写拉取请求(PR)正文时使用此模板,按统一结构呈现摘要、证据与合并风险,帮助评审者快速理解改动。

主要能力

模板包含三个部分:

  1. 摘要(Summary):放置图示、差异草图或树形结构,选择能让关键点最清晰的最小视图。可按需采用伪代码(逻辑或算法)、调用树(运行时控制流)、组件树(含状态与模块边界的 UI 结构)、浅层文件树(文件职责或大范围重构)、Mermaid 时序图(组件交互、控制流或数据流),以及 diff(当重点是“改了什么”且周边结构已存在时)。diff 可按组件、文件布局、调用树或状态/控制流等主题采用相应形态;当大部分内容为新增、省略上下文会隐藏归属或顺序、或需要可复制的目标形态时,可展示完整代码块。

  2. 证据(Evidence):要求给出改动前后的具体证据。截图被视为最高等级(适用于环境已就绪且改动为视觉性时);基于执行的证据为次高等级,如测试结果、控制台输出,并用伪代码展示现在失败与通过的精确测试。

  3. 合并风险(Merge Danger):说明改动属于单向门还是双向门——双向门可以退回,单向门不能;回滚成本低的 PR 风险更低,涉及破坏性操作或难以逆转决策的改动属于单向门。同时用一个词描述影响范围(Blast Radius),并可选说明合并可能带来的潜在后果,例如布局偏移、对使用方的破坏、移动端响应式问题等。

使用方式

按模板填写各部分。正文需跳过所有前言、保持文字简 brevity,并使用 GLOSSARY.md 中的用户领域语言。每个图示应紧邻其所支撑的简短文字,只保留回答当前问题或讨论当前选项所必需的元素;图示可选用一种或多种,但不宜全部使用,以免让用户不堪重负。

适用场景

适用于需要撰写结构化 PR 正文的代码评审场景,尤其是需要以图示辅助说明逻辑、流程、UI 结构、文件职责或具体差异,并需要提供改动前后证据与合并风险说明的场合。

限制

资料未提供该技能的具体安装方式、运行环境、支持的平台、收费信息或效果数据;以上均暂未提供。