SuperAPI AI 工具集

pr-diff-writer

编程与开发

查看项目

更新于 10-26 05:13

技能介绍

PR Diff Writer 是一个用于自动生成英文 Pull Request 标题与正文的智能体技能。其核心用途是分析当前分支相对于 main 分支的差异,并据此产出符合规范的 PR 文本。

主要能力包括:识别当前分支名称,优先以 origin/main 作为基准,若远程基准不可用则回退到本地 main;收集基准分支与 HEAD 之间的提交历史、文件级变更(新增/修改/删除)以及影响行为、API、测试、文档或构建的关键代码差异片段;判断主要变更类型(feat、fix、docs、chore、refactor、perf 或 test),并识别受影响的包范围,如 @agentscope-ai/design(packages/spark-design)、@agentscope-ai/chat(packages/spark-chat)、@agentscope-ai/flow(packages/spark-flow)、@agentscope-ai/clawd-chat-ui(packages/clawd-chat-ui)以及仅仓库层面的工程变更。

使用方式:当用户提出“生成 PR 标题/内容”“为 PR 总结当前分支”“基于与 main 的 diff 撰写 PR 正文”“起草拉取请求描述”等请求时触发。技能按固定工作流执行:先确定分支与基准,再收集变更上下文,然后判断 PR 意图与影响范围,接着起草标题(英文,尽量使用 Conventional Commit 风格,通常不超过 72 字符),最后按指定 Markdown 结构生成正文。正文结构包含变更类型、受影响范围、描述、验证项和发布影响等复选框与说明段落。输出时需同时给出 PR Title 和 PR Body 完整 Markdown 块,且标题与正文均为英文。

适用场景:开发者在提交 PR 前需要快速生成规范化的英文标题与描述;团队需要统一 PR 模板与变更分类;需要基于实际 diff 证据总结用户可见行为变化、风险区域、兼容性关注点以及测试增删情况。

限制:不得编造 diff 中不存在的改动;若 diff 为空,需明确说明并请求指导;生成的 PR 文本仅限英文;需在输出前核对标题与主要变更意图一致、复选框与实际变更对齐、受影响范围覆盖所有被触碰的包,并确保描述解释“为什么”而不仅是“改了什么”。