git提交规范
# git 提交规范
# 为什么需要制定提交规范?
在团队协作开发时,每个人提交代码时都会写 commit message。
每个人都有自己的书写风格,翻看我们组的 git log, 可以说是五花八门,十分不利于阅读和维护。
一般来说,大厂都有一套的自己的提交规范,尤其是在一些大型开源项目中,commit message 都是十分一致的。
因此,我们需要制定统一标准,促使团队形成一致的代码提交风格,更好的提高工作效率,成为一名有追求的工程师。
# 格式参考
type(scope) : subject
1
# type(必须)
type
是 commit 的类别,只允许使用下面几个标识:
feat: 新功能(feature)
fix: 修补bug
docs: 文档(documentation)
style: 格式(不影响代码运行的变动)
refactor: 重构(即不是新增功能,也不是修改bug的代码变动)
chore: 构建过程或辅助工具的变动
revert: 撤销,版本回退
perf: 性能优化
test:测试
improvement: 改进
build: 打包
ci: 持续集成
merge:代码合并
sync:同步主线或分支的bug(通常用于解决因为合并而引入的问题)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# scope(可选)
scope
用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
例如修改了 Dao 或者 Controller ,则可以添加表示这些范围受到影响,这有助于更清晰地理解提交的变更影响范围。例如:
feat(Controller): 添加用户登录功能
1
这个提交消息中,Controller 是 scope,表示这次提交影响了控制层。
fix(DataAccess): 修复数据查询逻辑
1
这个提交消息中,DataAccess 是 scope,表示这次提交影响了数据访问层。
如果你的修改影响了不止一个 scope,你可以使用 * 代替。
# subject(必须)
subject
是 commit 的简短描述,不超过50个字符。
# 学习参考
上次更新: 2024/10/25 18:25:10