Git commit message和工作流规范

目的

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

Git commit日志参考案例

总体方案

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分支

``` sh

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

``` sh

  $ git add .

  $ git commit                               # 此处不要加任何参数，比如-m

如下图所示：

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

  $ git push origin feature_infinite_load    # 将修改发布到远程仓库

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

  $ tnpm run changelog                    # 使用npm script中的changlog命令直接从git元数据生成日志。

  $ git tag v0.1.0

  $ git push origin v0.1.0

开源信息

腾讯NOW直播前端工程化解决方案feflow正式开源啦~： https://github.com/cpselvis/feflow-cli

Git commit message和工作流规范的更多相关文章

Git Commit Message 规范
今天来说说团队开发中,对于 Git commit message 规范问题. 社区上有各种 Commit message 的规范,本文介绍 Angular 规范,目前使用较广,比较合理和系统化,并且有 ...
如何写好git commit message
1.触发事件我有这样一个版本库,里面包含两个学习用的练习项目:BookStore(以下简称BS)和PictureFriend(以下简称PF) 我在更改PF以后,未进行提交,同时又到BS中优化了一下文 ...
我是怎么写 Git Commit message 的？
目录作用用的什么规范? type scope subject body footer 参考文章用的什么辅助工具? 作用编写格式化的 commit message 能够大大提高代码的维护效率. ...
git第四节----git commit message
@git commit message 什么是git commit message :git commit -m '每次提交时编辑的内容' git commit message的好处: 1 ...
Commit message 的写法规范。本文介绍Angular 规范（
Commit message 的写法规范.本文介绍Angular 规范( http://www.ruanyifeng.com/blog/2016/01/commit_message_change_lo ...
git使用总结（包含git commit message 和 changelog 工具的介绍）
[git的配置] 1.配置用户名和邮箱: 分为全局配置和局部配置 --system 系统配置 --global 全局配置 --local 局部配置 Git读取时:优先从local>glo ...
commitizen和cz-customizable配置git commit message
起因团队对提交的commit message格式有约定俗称的要求,但是没有一个统一的规范,导致大家提交的commit message或多或少不太一样.因此,需要一个工具来帮助大家统一commit m ...
优化 Git Commit Message
目前很多项目都是通过 Git 进行管理的,Git 每次提交代码的过程中提交说明 commit message 是必须的.但仅仅必须是不够的,好的提交说明可以帮助我们提高项目的整体质量. 作用与优点 ...
[译]How to Write a Git Commit Message
原文: http://chris.beams.io/posts/git-commit/ 介绍:为什么好的commit message很重要你浏览项目commit message的时候或多或少会有些困 ...

随机推荐

ANT编译时执行Junit测试
1.Junit.jar(和jakarta-ant-optional.jar 不是必须) 放在ant_home/lib中,用于支持build.xml中的<junit>标签 2.修改build ...
阿里CEO张勇公开信：把眼光从股市回到客户身上
8月25日消息,面对全球资本市场的剧烈波动,阿里巴巴集团CEO张勇今日发表致员工信,倡议全体阿里员工把眼光从股市回到客户身上,脚踏实地的服务帮助客户,为客户创造价值,继而为股东和自己创造价值. 张 ...
eclipse修改主题配色
1.Java-->Editor---> Syntax Coloring修改类中的各种代码颜色 2.General-->Editors --->Text Editors
封装bt轮播图淡入淡出效果样式
 <div data-ride="carousel" class="carousel slide carousel_inn ...
C-Sharp网络编程案例解析（Socket类的使用）
Server端: using System; using System.Collections.Generic; using System.Text; using System.Net; using ...
java环境设置与运行
在初学java编程语言时,痛苦的事莫过于跟着示例一步步做,总是得不到想要的结果,这是很多初学者都会碰到的问题.下面详细教你运行第一个java应用程序(环境windows xp + jdk 6.0): ...
js原生设计模式——9外观模式封装2(小型代码库YJ)
<script type="text/javascript"> //小型代码库YJ封装 var YJ = { //根据id获取元素 ...
Postman编程
Postman常用Api Postman像jmeter一样提供前置处理脚本和后置处理脚本.脚本主要使用JavaScript语法,并内置提供了一些js代码库,提供了一些内置对象和方法. 参考:https ...
viewpager翻页的窗帘效果动画
前端时间比较忙,好长时间没有更新微博,就工作中出现的部分问题,与大家分享一下. 大家都知道viewpager在android开发中是运用率比较高的控件,现在就其窗帘下过的动画分享. 文章出处:http ...
spring 定时任务 taskScheduler详解
spring 3.0版本后,自带了一个定时任务工具,而且使用简单方便,不用配置文件,可以动态改变执行状态.也可以使用cron表达式设置定时任务. 被执行的类要实现Runnable接口 TaskSche ...

Git commit message和工作流规范

目的

Git commit日志参考案例

总体方案

Git commit日志基本规范

Git分支与版本发布规范

如何接入？

接入后的Git commit操作流程

开源信息

Git commit message和工作流规范的更多相关文章

随机推荐

热门专题