SuperAPI AI 工具集

pr

通用与其它

查看项目

更新于 10-16 07:16

技能介绍

用途:在撰写 PR 正文时使用该模板,帮助作者用结构化方式说明变更内容、验证证据与合并风险。

主要能力:模板包含 Summary、Evidence、Merge Danger 三个核心章节。Summary 要求选择能说明关键点的最小视图,可用伪代码展示逻辑或算法、用调用树展示运行时控制流、用组件树展示 UI 结构与状态和模块边界、用浅层文件树展示文件职责或重构、用 Mermaid 展示组件交互或数据流,也可用 diff 展示具体变更;diff 需匹配主题,如组件变更、文件布局变更、调用树变更、状态或控制流变更。当大部分内容为新增、省略上下文会隐藏归属或顺序、或用户需要可复制的目标形态时,可展示完整代码块。Evidence 要求给出变更生效的具体证据,展示前后对比:截图在环境支持且变更为视觉性时最佳,基于执行的证据如测试结果、控制台输出次之,需用伪代码展示现在失败并已通过的测试。Merge Danger 要求说明是单向门还是双向门,并给出爆炸半径(一词描述)及可选的合并潜在影响。

使用方式:按模板填写各章节,跳过所有前言,保持文字简短,使用 GLOSSARY.md 中的用户领域语言。每个可视化放在其支持的简短文字旁边,只保留回答当前问题或解决当前讨论点所需的调用、文件、属性、状态和边界。可使用其中一种或几种呈现方式,不必全部使用,避免信息过载。

适用场景:需要撰写清晰、可评审的 PR 正文时。

限制:资料未提供具体安装命令、平台支持、收费或价格信息;模板中的代码示例仅为格式示意,实际内容需按项目情况填写。