git commit 规范

作者: 喜相逢v5 | 来源:发表于2018-05-29 17:42 被阅读82次

    使用angular + commitizen + cz-conventional-changelog 来规范git commit

    目的

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

    Git commit日志参考案例


    参考链接:

    总体方案

    image

    Git commit日志基本规范

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

    对格式的说明如下:

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

    格式要求:

    # 标题行:50个字符以内,描述主要变更内容
    #
    # 主体内容:更详细的说明文本,建议72个字符以内。 需要描述的信息包括:
    #
    # * 为什么这个变更是必须的? 它可能是用来修复一个bug,增加一个feature,提升性能、可靠性、稳定性等等
    # * 他如何解决这个问题? 具体描述解决问题的步骤
    # * 是否存在副作用、风险? 
    #
    # 尾部:如果需要的化可以添加一个链接到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项目。具体步骤如下:

    • 第一步:在工程跟目录下的package.json文件加入如下代码所示的scripts和dependencies内容,版本号为3位版本号。
     {
        "name": "application-name",
        "version": "0.1.0",
        "scripts": {
          "commitmsg": "validate-commit-msg",
          "commit": "git-cz ",
          "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
        },
        "devDependencies": {
          "commitizen": "^2.3.0",
          "validate-commit-msg": "^2.11.1",
          "conventional-changelog-cli": "^1.2.0",
          "husky": "^0.13.1"
        }
     }
    
    • 第二步:在工程根目录新建.vcmrc文件,并且文件内容为
    {
      "helpMessage": "\nPlease fix your commit message (and consider using https://www.npmjs.com/package/commitizen)\n",
      "types": [
        "feat",
        "fix",
        "docs",
        "style",
        "refactor",
        "perf",
        "test",
        "chore",
        "revert"
      ],
      "warnOnFail": false,
      "autoFix": false
    }
    

    接入后的Git commit操作流程

    • 第一步:创建一个feature分支或者bugfix分支
      $ git checkout -b feature_infinite_load    # 切换到一个feature分支或者bug fix分支
    
    • 第二步:将代码提交到本地Git仓库,并填写符合要求的Commit message格式
      $ git add .                                
      $ git commit                               # 此处不要加任何参数,比如-m
    

    如下图所示:

    image
    • 第三步:将代码同步到远程Git仓库
      $ git push origin feature_infinite_load    # 将修改发布到远程仓库 
    
    • 第四步:自动生成changelog,并打Tag发布
      $ npm run changelog                    # 使用npm script中的changlog命令直接从git元数据生成日志。
      $ git tag v0.1.0
      $ git push origin v0.1.0
    

    安装commitizen + cz-conventional-changelog

    npm install -g commitizen
    npm install -g cz-conventional-changelog
    

    使用命令 git cz 替代 git commit,出现angular规范选择,如图:
    [图片上传失败...(image-c98018-1527586920607)]

    生成输出文档使用命令:

    npm run changelog
    

    在当前项目目录中生成 CHANGELOG.md 文件,效果如图:

    changelog.jpg

    相关文章

      网友评论

        本文标题:git commit 规范

        本文链接:https://www.haomeiwen.com/subject/idvajftx.html