从其它平台迁移而来

一直以来，都是用git commit -m来提交代码的，结果就是看提交历史时一点儿都不赏心悦目！既然别人已经有好的实践了，那么就来学习一下吧。

提交消息格式

1
2
3
4
5

修改类型(影响范围):<--空格-->标题
<--空行-->
[正文]
<--空行-->
[页脚]
  • 任何一行都不能超过100个字符，以便在各种git工具中方便阅读

修改类型

以下选其一：

值 含义
feat 添加新功能
fix 修复bug
docs 只修改了文档
style 调整代码格式，未修改代码逻辑（如：调整空白、格式化等）
refactor 代码重构，既没修复bug也没添加新功能
perf 性能优化，提高性能的代码修改
test 添加或修改代码测试
chore 对构建流程或辅助工具和依赖库（如文档生成等）的更改
revert 代码回滚

影响范围

内容不固定，可以是代码影响到的任何内容，但要足够简要。如果影响到多个范围可以用*表示。

标题

必需，能简要描述本次提交的信息。

  • 不要大写首字母

  • 结尾不要使用句号

正文

非必需，是对标题的补充说明。

页脚

任何破坏性变更、不向下兼容都应在页脚中说明。也经常用来引用本次解决的issue。

  • 破坏性变更应以BREAKING CHANGE开头
1

BREAKING CHANGE:<--空格-->页脚内容

代码回滚

1
2
3
4
5

revert(影响范围):<--空格-->要恢复到的那个提交的标题
<--空行-->
This reverts commit <要恢复到的那个提交的hash>
<--空行-->
[页脚]