Git Commit 规范

目的

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

Git commit 日志参考案例

• angular
• commit-message-test-project
• babel-plugin-istanbul
• conventional-changelog

总体方案

Git commit日志基本规范

所有的 type 类型如下：

type代表某次提交的类型，比如是修复一个bug还是增加一个新的feature。

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

格式要求：

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文档，然后再发布上线。

如何接入？

接入参考git-commit-style-guide项目。具体步骤如下：

• 第一步：在工程跟目录下的package.json文件加入如下代码所示的scripts和dependencies内容，版本号为3位版本号。

• 第二步：在工程根目录新建.vcmrc文件，并且文件内容为

接入后的Git commit操作流程

• 第一步：创建一个feature分支或者bugfix分支

• 第二步：将代码提交到本地Git仓库，并填写符合要求的Commit message格式

如下图所示：

• 第三步：将代码同步到远程Git仓库

• 第四步：自动生成changelog，并打Tag发布