Git Commit 规范指南

用了那么久的git,输入git commit -m 之后是不是还是无从写起?大型项目的git提交记录看起来就很规范高大上。看看这篇短文,你也能写出高级感的git提交信息!

常用格式

1
2
3
4
5
<type>: <subject>




各部分说明

1. <type> 提交类型

类型图标描述
feat新功能
fix🐛修复 bug
docs📚仅修改文档
style💄不影响逻辑的代码格式(空格等)
refactor♻️代码重构(非功能、非修复)
perf提升性能
test添加或修改测试代码
build🛠️构建系统或依赖的变更
ci👷CI配置相关(GitHub Actions)
chore🧹杂务,如修改 .gitignore 等
revert回滚提交

2. [scope] 影响范围(可选)

表示本次 commit 影响的模块或功能块,如:

1
2
feat(auth): 添加登录功能
fix(api): 修复用户接口错误处理

3. <subject> 简要说明

  • 祈使语气,如:add, update, delete
  • 不用句号
  • 用英文的话小写即可

4. [body] 提交说明(可选)

说明为什么要做这个修改、修改的动机、解决的问题等,必要时写。建议 72 字换行。

常用于关联 issue 或注明 breaking change:

1
2
3
BREAKING CHANGE: 用户数据结构已更改,不兼容旧版本

Closes

✅ 示例

1
2
3
4
5
6
7
8
9
feat(user): 添加用户注册功能

新增用户注册页面,支持邮箱验证和密码强度检测。

fix(auth): 修复 JWT 校验失败的问题

原因是 token 过期未处理,已增加刷新机制。

Closes #45

小tips

在github还有gitee的网页版上,输入#加数字就能跳转到对应issue的页面。、

以上内容可以复制下来丢给人工智能,然后把git diff --cache | cat的内容附上,就能自动写出git提交信息啦!

实测:

DeepSeek生成提交信息

评论

留下神评妙论