SuperAPI AI 工具集

pr

通用与其它

查看项目

更新于 10-16 07:14

技能介绍

用途:这是一个用于撰写 PR(Pull Request)正文的模板技能,触发场景为“需要撰写 PR 正文时”。它规定了 PR 正文应包含的章节结构与呈现方式,帮助作者把变更说明写清楚。

主要能力与结构要求:PR 正文包含三大部分。一、Summary(摘要):跳过所有开场白,保持文字简短,使用 GLOSSARY.md 中用户领域的术语;选取最小但能说明关键点的视图来表达。二、Evidence(证据):给出变更确实生效的具体证据,展示修改前与修改后(Before / After),例如截图、输出或失败/通过的测试运行。三、Merge Danger(合并风险):说明这是单向门还是双向门(Door: one-way 或 two-way),以及爆炸半径(Blast Radius,用一个词描述),可补充合并可能带来的潜在后果。

可视化呈现方式:摘要部分可视情况选用以下一种或多种形式——用伪代码展示逻辑或算法;用调用树展示运行时控制流(如 submitForm → createSession → persistPrompt → launchAgent → navigateToSession);用组件树展示 UI 结构,标注有影响的状态与模块边界;用浅层文件树展示文件职责或大规模重构;用 Mermaid 展示组件交互、控制流或数据流;当关注点是“变了什么”且周边结构已存在时使用 diff,diff 的形状要与主题匹配(组件变更、文件布局变更、调用树/调用栈变更、状态或控制流变更各有示例)。当整段代码大部分是新增、省略上下文会掩盖归属或顺序、或需要可复制的目标形态时,展示完整代码块。

使用建议:每个可视化放在它所支撑的简短文字旁边;只保留回答当前问题或解决当前讨论点所需的调用、文件、属性、状态和边界;可用一种或多种,但不太可能全部用上,需自行判断、不要给读者造成信息过载。

证据等级:截图为 S 级(当环境支持且变更为视觉性时);基于执行的证据为 A 级,如测试结果、控制台输出,用伪代码展示现在失败和通过的准确测试。

限制:资料未提供该技能的安装方式、依赖、收费或平台信息,暂未提供。