git commit规范

发布时间 2024-01-12 15:16:52作者: Karle

git commit message基本格式

<type>(<scope>): <subject>

type(required)

用于说明git commit的类别,只允许使用下面的标识。

feat:新功能(feature)。

fix:修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG。

docs:文档(documentation)。

style:格式(不影响代码运行的变动)。

refactor:重构(即不是新增功能,也不是修改bug的代码变动)。

perf:优化相关,比如提升性能、体验。

test:增加测试。

chore:构建过程或辅助工具的变动。

revert:回滚到上一个版本。

merge:代码合并。

sync:同步主线或分支的Bug。

scope

用于描述改动影响的范围,范围过大可以使用*

subject(required)

对改动内容的描述,不超过五十字

e.g.
feat:get bank list by network call
fix:bank list render without bank name