SuperAPI AI 工具集

pr-description-writer

编程与开发

查看项目

更新于 10-16 00:29

技能介绍

用途:编写并核验 GitHub Pull Request 描述,遵循项目 PR 模板,坚持零虚构原则,确保描述中的每项声明都有实际代码变更支撑,并采用技术文档核验标准,防止营销语言和未经验证的声明。

两种模式:创建模式(默认)分析 git diff 与提交历史,查找项目 PR 模板,生成用于 gh pr create --body 的 Markdown 描述;核验模式审计已有 PR 描述,将声明与 git 变更比对,标记虚构功能或未验证声明,识别营销语言并输出核验报告。

核心流程五阶段:模板发现(在 .github/ 或 docs/ 中查找)、变更分析(git diff 与提交历史)、描述生成(按模板填充已核验内容)、核验(P0/P1/P2 检查清单)、输出生成(含核验元数据)。

模板章节:必需项包括 Summary、Changes、Testing、Related Issues、Checklist;条件项包括 Breaking Changes、Migration Guide、Performance Impact;可选项包括 Screenshots、Security Considerations、Deployment Notes、Rollback Plan。

核验规则:P0 关键项(阻止创建 PR)禁止虚构功能、文件、方法或 API,禁止无基准的性能改进声明,禁止虚构测试覆盖率,所有代码引用须与 git diff 一致;P1 高优先项禁止营销流行词(如 enterprise、blazing、cutting-edge)和技术文本中的装饰性 emoji。

常见问题:模板嵌套 YAML front matter 时只解析 Markdown 标题;多个模板时使用 default.md 或询问用户;无完整 git 历史时需告知用户;提交信息冲突时以实际代码变更为准并采用最新提交信息。

集成:可由 create-pr 技能在生成 PR 描述步骤调用,也可手动调用;与 check-history、api-documentation-verify、safe-commit 配合使用。

用法示例:用户说“create a PR”时由 create-pr 自动调用;说“write a PR description for my changes”时进入创建模式;说“verify the PR description for #47”时进入核验模式。

时间估算:创建模式小 PR 约 10-15 分钟,中 PR 约 15-25 分钟,大 PR 约 25-40 分钟;核验模式约 5-10 分钟。

限制:依赖完整 git 历史;核验模式需能获取 PR 描述与分支 diff;不提供自动修复,仅报告问题与建议。