Community写作与编辑github.com

agentkitco/agentkit-dev-skills

根据实际的 diff 和提交记录,编写包含变更内容、原因、测试方式以及审查要点的拉取请求标题和描述。适用于被要求编写或改进 PR 描述时使用。

agentkit-dev-skills 是什么?

该技能旨在帮助 AI 代理(如 Claude Code、Cursor 或 Codex)自动生成高质量、结构化的拉取请求描述。它通过分析当前分支与基础分支之间的实际代码差异和提交历史,提取变更的动机、实现细节、测试证据和审查指南,从而让审阅者能在两分钟内快速理解变更内容,也让未来的读者明白改动的原因。技能支持 GitHub、GitLab 等主流平台,遵循严格的规则:如实描述 diff 的行为而非主观意图,不罗列所有文件而聚焦行为变更,不添加无意义的填充语,并检查仓库中是否存在 PR 模板。最终输出可直接复制的标题和正文代码块,适用于任何 CI/CD 或代码审查工作流。

兼容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/agentkitco/agentkit-dev-skills/tree/HEAD/skills/pr-description

Installed? Explore more 写作与编辑 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

编写审阅者可用的 PR 描述

目标:让审阅者在两分钟内决定要看什么,让未来的读者理解变更存在的原因。

收集

  1. 找到基础分支,然后运行 git log --oneline <base>..HEAD 和 git diff --stat <base>...HEAD,再阅读 diff。
  2. 寻找变更原因:提交或分支名称中关联的问题或工单编号、用户请求、diff 中添加的注释。如果原因不在以上任何地方,请询问用户;切勿虚构动机。
  3. 检查测试情况:diff 中的测试文件,以及用户运行过的命令。如果测试未运行,请如实说明。
  4. 查找是否存在 .github/pull_request_template.md 或 PULL_REQUEST_TEMPLATE。如果有,则填写该模板,而不是使用下面的结构。

结构

<Title: 祈使语气,不超过 70 个字符,命名行为变更而非文件>

## Why
<问题或请求,1 到 3 句话。如有问题则链接它。>

## What changed
- <按领域分组的行为级别要点,不是文件列表。>

## How to review
- 从 <文件或领域> 开始;其余部分随之而来。
- 风险部分:<最容易出错的部分及其原因>。
- 有意未修改:<审阅者可能期望看到但不会发现的内容>。

## Testing
- <运行的确切命令及其结果。>
- <手动步骤及观察到的现象。如果适用,写明“未测试:...”>。

## Rollout / risk
<迁移、配置、功能标志、兼容性、回滚方式。仅在确实没有时才写“None”。>

规则

  • 描述 diff 实际做了什么,而不是你希望它做什么。起草后重新阅读 diff,删除任何 diff 不支持的声明。
  • 不要列出每个文件。但要列出行为变更、新配置、新依赖和删除的代码。
  • 不要使用填充语(例如“此 PR 旨在……”)。除非仓库使用表情符号,否则不要使用表情符号。
  • 截图或输出示例:说明在何处会有帮助;永远不要描述你未见过的截图。
  • 将标题和正文放在代码块中输出,以便复制。除非被要求,否则不要运行 gh pr create。

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

相关技能