SuperAPI AI 工具集

pr-description-writer

通用与其它

查看项目

更新于 10-16 06:14

技能介绍

用途:针对 GitHub 拉取请求(PR)生成或改进描述,让作者清晰传达改动,评审者更快理解上下文。

主要能力覆盖三种场景:

  1. 从零生成新 PR 描述:分析主分支以来的提交与文件变更,提取改动及其原因,区分核心逻辑与辅助改动,按结构化模板输出 Summary、Context、Implementation、文件组织、测试策略与风险评估,并指出应优先评审的文件。
  2. 更新已有 PR 描述:当在评审中的 PR 新增提交(如回应反馈)时,分析新提交,读取原描述以保留原意,更新 Implementation 与 Testing 等受影响部分,保持结构连续并可直接粘贴回 GitHub。
  3. 评审与改进描述:对照最佳实践找出缺失的上下文、实现说明或测试细节,给出改进版本或具体反馈。

使用方式:依托资源实现。运行 scripts/analyze_git_commits.py 获取当前分支相对 main/master 的提交列表、增删改文件与 diff 统计,输出人类可读摘要与结构化数据;references/pr_description_guide.md 提供章节结构、不同规模 PR 的最佳实践与常见反模式;assets/ 内含 pr_template.md、example_good_pr.md、example_weak_pr.md 等示例。

原则:依据提交而非编造;按重要性而非文件清单组织,突出必须先审的核心逻辑;先解释“为什么”再讲“改了什么”;提供可直接执行的测试指引与明确风险标记(破坏性变更、性能影响等)。

适用场景:新建 PR、评审中追加提交、审阅描述质量。

限制:依赖 git 提交信息与 diff,提交信息不清晰时输出质量受限;具体安装方式、支持的运行环境与收费信息暂未提供。