首页/AI 提示词库/编程开发/Git 提交信息规范

Git 提交信息规范

⌨ 编程开发 适配:通用(GPT / Claude / DeepSeek / 通义)难度:入门 3 个变量一键复制
使用说明

把一堆改动整理成符合约定的提交信息,并给出拆分建议。

提交前整理、代码评审、生成变更日志。

提示词模板未填写变量以红色标出
帮我把这些改动整理成合适的提交。

【改动内容】{{改动内容}}
【提交规范】{{规范}}
【项目约定】{{项目约定}}

输出:
1. 拆分建议:判断应该拆成几个提交,每个提交包含哪些改动,说明为什么这样拆(一个提交只做一件事 / 便于回滚)。
2. 每个提交的完整信息:
   - 第一行:type(scope): subject,符合{{提交规范}}
   - 空行后 body:说明「为什么改」,3 行内
   - 必要时 footer:BREAKING CHANGE 或关联 issue
3. type 选择说明:feat/fix/refactor/docs/chore/test 各自适用边界,指出本次容易混淆的 2 处。
4. 需要写 BREAKING CHANGE 的情况判断,若有请给完整写法。
5. 3 个正反例对比:写得好与写得差的提交信息各 3 组,说明差在哪。
6. 一条 git 命令:如何只提交部分文件(git add -p 或指定路径),配合上面的拆分。
7. 若需要生成 CHANGELOG:按 type 分组的模板片段。

不要写「update code」「fix bug」这类无信息量的描述。
填变量变量会自动替换进上方模板,可随时复制
已填 0 / 3
使用步骤
  1. 一个提交只做一件事。
  2. subject 说做了什么,body 说为什么。
  3. 破坏性改动一定要写 BREAKING CHANGE。
用 -p 拆提交
比 git add . 然后写一大段说明清楚得多。
提交信息是给未来的自己
半年后回滚时最需要它。
常见问题
中文还是英文?

团队统一即可,中文更利于国内协作,type 保留英文。

要不要写得特别详细?

说清动机即可,不要复述代码。