0%

Git提交规范

Git commit message格式

 

<type>(scope):<subject>

type(必须)

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

feat:新功能(feature)

fix/to:修复Bug,可以是QA发现的Bug,也可以是研发自己发现的Bug

  • fix:产生diff并自动修复此问题,适用于一次提交直接修复问题

  • to:只产生diff不自动修复此问题,适合多次提交,最终修复问题提交时使用fix

docs:文档(documentation)

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

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

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

test:增加测试

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

revert:回滚到上一个版本

merge:代码合并

sync:同步主线或分支的Bug

 

scope(可选)

scope用于说明commit影响的范围,比如数据层、控制层、视图层等。视项目不同而不同。

比如compile、cast、connection等,如修改的影响的不止一个scope,可用*代替

 

subject(必须)

subject时commit目的的简短描述,不超过50个字符。建议使用中文

  • 结尾不加句号或其他标点符号

  • 根据以上规范git commit message将是如下格式:

chore(compile):支持iOS编译