Commit Message 规范

时间 2019-12-10

标签 commit message 规范繁體版

原文原文链接

统一团队 Git commit 日志标准，便于后续代码 review ，版本发布以及日志自动化生成等等。
统一团队的Git工做流，包括分支使用、tag 规范、issue 等。

Git commit日志基本规范

<type>(<scope>): <subject> 
<BLANK LINE> 
<body> 
<BLANK LINE> 
<footer>

对格式的说明以下：html

type表明某次提交的类型，好比是修复一个bug仍是增长一个新的feature。全部的type类型以下：git

feat：新增feature
fix: 修复bug
docs: 仅仅修改了文档，好比README, CHANGELOG, CONTRIBUTE等等
style: 仅仅修改了空格、格式缩进、都好等等，不改变代码逻辑
refactor: 代码重构，没有加新功能或者修复bug
perf: 优化相关，好比提高性能、体验
test: 测试用例，包括单元测试、集成测试等
chore: 改变构建流程、或者增长依赖库、工具等
revert: 回滚到上一个版本

格式要求：

# 标题行：50个字符之内，描述主要变动内容

# 主体内容：更详细的说明文本，建议72个字符之内。 须要描述的信息包括:

# * 为何这个变动是必须的? 它多是用来修复一个bug，增长一个feature，提高性能、可靠性、稳定性等等

# * 他如何解决这个问题? 具体描述解决问题的步骤

# * 是否存在反作用、风险? 

# 尾部：若是须要的化能够添加一个连接到issue地址或者其它文档，或者关闭某个issue。

Commit messages书写建议

尽量多的提交，单个Commit messages包含的内容不要过多；
标题行以Fix, Add, Change, Delete开始，采用命令式的模式。不要使用Fixed, Added, Changed等等；
始终让第二行是空白，不写任何内容；
主体内容注意换行，避免在gitk里面滚动条水平滑动；
永远不在 git commit 上增长 -m 或 --message= 参数，提交的时候git commit便可；
若是你是vim用户，将下面这行代码加入到~/.vimrc。这会帮助你检查拼写和自动换行。 autocmd Filetype gitcommit setlocal spell textwidth=72

使用Commitizen工具

Commitizen可让你的commit message更加规范统一，适合项目团队使用，使用也很简单，使用npm安装后，提交代码的时候使用git cz去替代之前的git commit命令便可。
安装commitizen：npm

npm install -g commitizen

使用截图：vim

自动生成Change log工具

conventional-changelog是用来从git的元数据中生成 Change log文档的工具，只要你提交的格式知足它定义的标准，此处以angular标准为例子。使用它生成的Change log包含如下三个部分：post

Bug Fixes Bug修复的信息
Features 增长的特性
BREAKING CHANGES 重大变动

能够参考它生成的文档CHANGELOG.md，使用以下：性能

$ npm install -g conventional-changelog-cli 
$ cd my-project
$ conventional-changelog -p angular -i CHANGELOG.md -s

Git分支与版本发布规范

基本原则：master为保护分支，不直接在master上进行代码修改和提交。单元测试

开发平常需求或者项目时，从master分支上checkout一个feature分支进行开发或者bugfix分支进行bug修复，功能测试完毕而且项目发布上线后，将feature分支合并到主干master，而且打Tag发布，最后删除开发分支。分支命名规范：
分支版本命名规则：分支类型分支发布时间分支功能。好比：feature_20170401_fairy_flower测试
- 分支类型包括：feature、 bugfix、refactor三种类型，即新功能开发、bug修复和代码重构
- 时间使用年月日进行命名，不足2位补0
- 分支功能命名使用snake case命名法，即下划线命名。
Tag包括3位版本，前缀使用v。好比v1.2.31。Tag命名规范：优化
- 新功能开发使用第2位版本号，bug修复使用第3位版本号
- 核心基础库或者Node中间价能够在大版本发布请使用灰度版本号，在版本后面加上后缀，用中划线分隔。alpha或者belta后面加上次数，即第几回alpha：
  - v2.0.0-alpha-1
  - v2.0.0-belta-1

版本正式发布前须要生成changelog文档，而后再发布上线。

参考资料

Commit message 和 Change log 编写指南阮一峰
 如何写好 Git commit messages 腾讯IVWEB团队
 如何写好 Git commit log? 知乎
 优雅的提交你的 Git Commit Message 阿里
 你可能会忽略的 Git 提交规范掘金