用途:在准备提交 Pull Request 或合并请求时,根据当前分支名与 diff 起草标题和描述,让评审者快速获得上下文。触发场景包括用户即将开 PR、要求“PR description”“draft my PR”,或完成功能后请求评审前。
主要能力:收集分支名、基础分支(如 main)与 diff(git diff base..head 或已暂存加未暂存改动),可选从分支或提交中提取工单号;总结改动的核心结果;起草简短、祈使句式的标题(约 50 字符,可按项目习惯加 [PROJ-123] 前缀);按项目模板或默认结构撰写描述,包含 What、How、Testing、Screenshots/notes、Related 等小节;若存在 .github/PULL_REQUEST_TEMPLATE.md 等模板,则沿用其章节与清单逐项填写。
使用方式:提供必需输入(分支名、diff 或 refs,非默认时提供基础分支),可选提供工单号与模板路径。标题保持祈使、简洁、无句号,一个 PR 聚焦一个主要改动。描述默认结构为:What(1–3 句说明做了什么及原因)、How(技术要点,可用列表)、Testing(验证命令或手动步骤)、Screenshots/notes(UI 改动时)、Related(Fixes #123 等)。
限制与规则:不得编造 diff 中不存在的改动;diff 过大或混杂(如重构加功能)时应说明并建议拆分或概括主主题;标题与 What 需与分支名一致;Testing 必须可操作,避免只写“本地测过”;仅部分解决问题时用 Ref #123 或 Part of #123,而非 Fixes;不要直接复制提交信息,应综合为 PR 级别描述。资料未提供具体安装命令、收费或平台信息。