Commit message 的作用

比如,下面的命令显示上次发布后的变动,每个commit占据一行。你只看行首,就知道某次 commit 的目的。

  • 提供更多的历史信息,方便快速浏览。

    1. git log <last tag> HEAD --pretty=format:%s
  • 可以过滤某些commit(比如文档改动),便于快速查找信息

    1. git log <last release> HEAD --grep feature
  • 可以直接从commit生成Change log。
    Change Log 是发布新版本时,用来说明与上一个版本差异的文档,详见后文。

目前,社区有多种 Commit message 的写法规范。
本文介绍Angular 规范是目前使用最广的写法,比较合理和系统化,并且有配套的工具。前前端框架Angular.js采用的就是该规范。

Commit message 的格式

每次提交,Commit message 都包括三个部分:header,body 和 footer。

  1. <type>(<scope>): <subject>
  2. <BLANK LINE>
  3. <body>
  4. <BLANK LINE>
  5. <footer>

type

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

说明

  1. # 标题行:50个字符以内,描述主要变更内容
  2. #
  3. # 主体内容:更详细的说明文本,建议72个字符以内。 需要描述的信息包括:
  4. #
  5. # * 为什么这个变更是必须的? 它可能是用来修复一个bug,增加一个feature,提升性能、可靠性、稳定性等等
  6. # * 他如何解决这个问题? 具体描述解决问题的步骤
  7. # * 是否存在副作用、风险?
  8. #
  9. # 尾部:如果需要的化可以添加一个链接到issue地址或者其它文档,或者关闭某个issue。

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-test-project项目。
连接地址:https://github.com/feflow/git-commit-style-guide

用到的依赖

commitizen

该工具是基于Node的,因此我们首先必须先安装node环境 ,node环境好了后便可以开始安装我们的

husky

husky继承了Git下所有的钩子,在触发钩子的时候,husky可以阻止不合法的commit,push等等。

具体步骤

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

    1. {
    2. "name": "application-name",
    3. "version": "0.1.0",
    4. "scripts": {
    5. "commitmsg": "validate-commit-msg",
    6. "commit": "git-cz ",
    7. "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
    8. },
    9. "devDependencies": {
    10. "commitizen": "^2.3.0",
    11. "validate-commit-msg": "^2.11.1",
    12. "conventional-changelog-cli": "^1.2.0",
    13. "husky": "^0.13.1"
    14. }
    15. }
  • 第二步:在工程根目录新建.vcmrc文件,并且文件内容为

    1. {
    2. "helpMessage": "\nPlease fix your commit message (and consider using https://www.npmjs.com/package/commitizen)\n",
    3. "types": [
    4. "feat",
    5. "fix",
    6. "docs",
    7. "style",
    8. "refactor",
    9. "perf",
    10. "test",
    11. "chore",
    12. "revert"
    13. ],
    14. "warnOnFail": false,
    15. "autoFix": false
    16. }
  • 第三步,执行npm install,前提:已经安装node
    注意:执行npm install后,会下载对应的依赖,最好不要copy node_modules依赖,执行npm install自行安装。

如果在提交代码时,不希望进行校验,则加上参数:–no-verify