SuperAPI AI 工具集

pr-description

编程与开发

查看项目

更新于 10-15 16:45

技能介绍

用途:在创建新 Pull Request,或用户要求“创建/撰写 PR 描述”时,按统一结构生成完整的 PR 描述,便于代码评审。

主要能力:提供固定结构模板(PR 标题、摘要、数据流图、实体关系图、目标、改动内容、测试、评审提示、后续工作);支持使用 Mermaid 绘制数据流图与 ERD;可选用 mermaid 技能调整图表样式以适配明暗模式。测试部分要求列出实际运行的命令(如 npm test、npm run lint)并给出通过证据。

使用方式:按模板逐项填写;如需保存为文件,命名规则为 pr_description_<描述性标题><时间戳>.md,时间戳用 date +"%Y%m%d%H%M%S" 获取(示例:pr_description_user_auth_refactor_20250612_152832.md)。图表引用 mermaid 技能。若改动范围不明确可向用户询问;若尚未测试应提醒先运行测试;若未提供图表可先放占位图并请用户确认。

适用场景:需要清晰说明业务背景与改动原因、包含配置或 schema 变更、存在破坏性变更、或需向评审者展示测试证据的代码提交。

限制:资料仅提供撰写指南与模板,未说明具体平台支持、收费方式或与特定代码托管工具的集成细节;图中具体样式、命令与测试结果需使用者自行提供。