SuperAPI AI 工具集

github-pr-description

编程与开发

查看项目

更新于 10-16 04:29

技能介绍

用途:根据当前分支相对主干的改动,自动生成结构化的 PR 描述并直接用 GitHub CLI 创建 Pull Request。

主要能力:先验证前置条件(查看当前分支、确认不在 main/master、确认领先主干的提交);再收集上下文(提交信息、diff 摘要、实际代码改动,大 diff 时抽样关键文件);随后判定变更类型(fix、feature、performance、refactor、docs、test、chore);再生成含 Summary、Context、Changes、Key Implementation Details、Use Cases、Testing、Links 等段落的描述,最后创建 PR 并反馈 PR URL、变更类型与摘要。

使用方式:必要命令保持原样,如 git branch --show-current、git log origin/main..HEAD --oneline、git log origin/main..HEAD --pretty=format:"%s"、git diff origin/main..HEAD --stat、git diff origin/main..HEAD。描述写入 .forge/FORGE_PR_DESCRIPTION.md,再用 gh pr create --title "[Change Type]: [One-line summary]" --body-file .forge/FORGE_PR_DESCRIPTION.md 创建;gh 预装且已认证,可直接使用;临时文件在 .forge/ 目录下(通常被 gitignore),创建后应删除。

适用场景:功能新增、Bug 修复、性能优化、重构、文档与测试变更、维护任务等 PR。

限制与注意事项:在 main/master 或无领先提交时应告知用户无可创建内容;避免空描述、占位文本、逐文件罗列、以个人清单充当主描述、假定评审者已知上下文;小改动可用 Summary、Context(简)、Testing 的简短结构,但测试说明不可省略;应如实说明已知问题或局限。示例中的 OpenAI、curl 及具体 npm 命令均来自资料示例,非本技能强制要求;官方是否收费、支持平台等暂未提供。