提交说明 · 程序员
用 AI 智能体做这件事
提交信息直接影响评审和回溯,得贴团队规范写。这个场景先声明团队提交规范(标题字数上限、是否要关联 issue)和托管平台(GitHub / GitLab / 内部仓库),再按规范写出一行标题加要点正文,并给几个口语化版本方便选用。diff 没贴全的标【待补】。
你需要准备
- 代码托管平台与提交 / 合并流程(GitHub PR / GitLab MR / 内部仓库)
- 团队提交规范:标题字数上限、是否需要关联 issue、是否用 Conventional Commits
- 本次改动的 git diff 或变更文件清单
- 变更目的、关联的 issue 或需求(缺失先标【待补】)
怎么做
- 先声明托管平台与团队提交规范
- 若 diff 含密钥、token 或连接串,先脱敏
- 贴 diff 与变更目的,粘贴提示词
- 按规范挑一版,补上缺失的 issue 号后再提交
一句话提示词
下面是我这次改动的代码(或 git diff),团队提交规范(标题字数上限、是否要关联 issue)和代码托管平台(GitHub / GitLab / 内部仓库)我先声明,帮我写规范的 Git 提交信息:一行不超过 50 字的标题概括改动,下面用要点列出改了什么、为什么改,再给 3 个更口语化的版本,方便我按团队规范选用;diff 里没贴全的部分请标【待补】,不要编造。
它会交付什么
- 规范的 Git 提交信息:一行标题(按你的字数上限)+ 要点正文(改了什么、为什么改)
- 3 个更口语化的版本,方便按团队规范选用(属 AI 建议,需人工判断)
- 未关联的 issue 号或变更目的,缺失处标【待补】
效果示例
输入一段改了登录逻辑的 git diff + 规范「Conventional Commits」→ 输出 `fix: 修复登录超时` 的标题与正文,并给出口语化版本;改动目的未写处标【待补】。(选版为建议,需人工判断)
常见问题
不给团队规范行吗?
不建议。字数上限和是否要 issue 号各团队不同,先声明才不多写。
它能替我想清改动原因吗?
只能依据你给的 diff 和目的描述;没给目的会标【待补】,不要让它编。
diff 里有密钥怎么办?
先脱敏再粘贴;提交信息里也不应出现密钥。
一次能处理多大的 diff?
建议一个提交为一个改动单元,特别大的 diff 请按文件拆开分批写。