Git 提交代码说明
用 git 提交代码、写不出规范的提交说明时,AI 能按团队规范把 git diff 概括成一行标题加要点正文,说清改了什么、为什么改,另给 3 个口语化版本。是否用 Conventional Commits 由你拍板。
你需要准备
- 代码托管平台与提交 / 合并流程(GitHub PR / GitLab MR / 内部仓库)
- 团队提交规范:标题字数上限、是否关联 issue、是否用 Conventional Commits(未定处标【需确认】)
- 团队已有提交记录或规范示例(用于对齐风格与 type 前缀,缺的标【待补】)
- 本次改动的 git diff 或变更文件清单
- 变更目的、关联的 issue 或需求编号、当前分支名(缺失先标【待补】)
怎么做
- 先声明托管平台与团队提交规范(含标题字数上限)
- 若 diff 含密钥、token 或连接串,先脱敏
- 贴 diff、分支名与变更目的,让 AI 按规范写标题与正文(提示词可直接复制)
- 按规范挑一版,补上【待补】的 issue 号后再提交
一句话提示词
下面是我这次改动的代码(或 git diff),团队提交规范(标题字数上限、是否关联 issue、是否用 Conventional Commits)、团队已有的提交记录或规范示例,以及代码托管平台(GitHub / GitLab / 内部仓库)我先声明,帮我写规范的 Git 提交信息:标题一行不超过我声明的字数上限(我没声明就按 50 字),概括改动,下面用要点列出改了什么、为什么改;再给 3 个更口语化的版本,口语化版本也要符合我声明的规范(如保留 type 前缀),方便我按团队规范选用;diff 里没贴全的部分或没给的 issue 号请标【待补】,不要编造。
它会交付什么
- 规范的 Git 提交信息:一行标题(按你声明的字数上限,未声明按 50 字)+ 要点正文(改了什么、为什么改)
- 3 个更口语化的版本,仍符合你声明的提交规范(属 AI 建议,需人工判断)
- 未关联的 issue 号或变更目的,缺失处标【待补】
效果示例
输入一段改了登录逻辑的 git diff + 规范「Conventional Commits」→ 输出 `fix: 修复登录超时` 的标题与正文,并给出口语化版本;改动目的未写处标【待补】。(示例为示意;选版为建议,需人工判断)
常见问题
Git 提交信息怎么写才规范?
先声明字数上限、是否关联 issue 与是否用 Conventional Commits,AI 会按该规范给出标题 + 要点正文;口语化版本也保留 type 前缀。
它能替我想清改动原因吗?
只能依据你给的 diff 和目的描述;没给目的会标【待补】,不要让它编。
git diff 里有密钥、token 能直接发吗?
不能,先脱敏再粘贴;提交信息里也不应出现密钥。
一次能处理多大的 diff?
建议一个提交为一个改动单元,特别大的 diff 请按文件拆开分批写。