用途:该技能用于在 GitHub 上创建 Pull Request 时撰写或编辑 PR/MR 描述,输出为符合规范的 Markdown 文档,供人类阅读。不适用于 commit 信息。
主要能力:提供 PR 描述的结构与风格指南。结构上建议按顺序用段落说明:变更解决的问题(可引用 issue、PR 或文档)、解决方案及其如何解决问题、读者如何手动验证(如本地运行的代码示例或命令)、测试策略、文档或 README 变更、后续需要的代码改动;不相关的部分应省略。
风格要求:使用简单平实的英语,避免技术术语与行话;不使用缩写,除非 API、RPC、HTTP 等极常见词;保持高层视角,描述代码无法表达的架构、设计决策与权衡,而非复述代码行为;始终使用美式英语拼写;不引用智能体对话或聊天历史,也不引用仓库提交历史之外的本地文件或文档。
Markdown 格式:使用 GitHub 风格 Markdown,不使用硬换行;引用代码时用反引号包裹类名、变量名等;用 <detail> 元素隐藏冗长的代码示例或日志输出。
应避免的反模式:罗列代码改动清单(diff 已包含)、过度使用标题、引用智能体对话或文件。
验证:完成后自问“能否更短”并精简两次,尽量用代码块和图表替代文字;确认代码用反引号包裹、无标题元素、无文件改动清单、无智能体对话或文件引用、无提交历史之外的文件引用、无空章节或无意义段落。
限制:资料未提供该技能的安装方式、平台支持范围、收费信息或具体使用命令。