用途:当用户要求创建、撰写或起草拉取请求描述时,分析暂存的 git 变更、提交历史与项目约定,生成一份完整、便于评审的 PR 描述,输出为可直接粘贴的 Markdown 正文,重点说明每项变更背后的“为什么”。
主要能力:先读取项目上下文,检查 .chalk/docs/engineering/ 下的文件(尤其是 PR 规范、编码风格与架构文档),若存在规范文件则遵循其 PR 模板,否则使用默认结构。随后收集 git 上下文,运行 git diff --cached --stat 查看变更文件概览、git diff --cached 查看完整暂存差异、git log --oneline -10 获取近期提交、git branch --show-current 获取分支名;若 $ARGUMENTS 含 issue 编号且可访问,则读取该 issue 详情。分析差异时先归类变更:判断主要意图(功能、修复、重构、杂项、文档),按关注点分组文件变更,标注删除、重命名或权限显著变化的文件,并标记潜在风险(新依赖、迁移文件、API 契约变更、安全敏感文件)。再根据变更类型与范围调整描述语气,最后按输出结构撰写。
输出结构:包含 Summary、Motivation、Changes(按关注点分组,大 PR 可用子标题)、Testing、Screenshots(仅 UI 变更)、Reviewer Notes、Related Issues,以及 Checklist(本地测试通过、无新增控制台错误或警告、无障碍检查、文档更新、迁移测试、功能开关配置)。不适用的小节应省略,而非填“N/A”。生成后以 Markdown 代码块打印完整描述供复制;若 PR 已打开,建议使用 gh pr edit 命令更新。
适用场景:功能、缺陷修复、重构、依赖更新等各类 PR 的说明撰写,尤其适合需要向评审者解释意图、权衡与风险的项目。
限制:依赖暂存的 git 变更与可访问的项目文档、issue;未提供具体安装方式、收费与平台信息。