不知道大家有没有看过自己项目的git 提交信息-----我看过好多次 ，不忍直视  然后提醒一起的小伙伴 ：大家规范点 信息要详细，

过段时间再看下 ,还是一样。

相信很多猿都有这样的感受，对于垃圾的提交信息深恶痛绝，特别是那些提交信息为 "fix bug"的commit,SO, 如果提交的时候能有

些填写规范的提示  或者高级点有交互式的约束就好了。

这里给出两种方案，也是业界比较通用的

1. commitizen 交互式约束命令 提交

2.配置git commit 模板

先来介绍第一种：（基于MAC OS 安装）

知名前端web项目AngularJS的提交记录在业内被许多人称赞，其规范同时也逐渐被大家引用，为了把这些规范实际应用到项目中，我

们就需要 commitizen 这个小工具，该工具是基于Node的，因此我们首先必须先安装node环境 ,node环境好了后便可以开始安装我们的

利器了,步骤很简单：

　　a.   npm 全局安装利器 commitizen

npm install -g commitizen

b.安转规范模板文件

这里有个要注意的地方 规范模板文件分全局（也就是说 这个规范适用于你电脑上所有的git 项目）的和单个仓库(只针对一个git工程)的

　    全局安装 :

先全局下载 规范模板文件

1. npm install -g cz-conventional-changelog   其中 cz-conventional-changelog 这个东西就是AngularJS的规范

2. echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc  ，此时你当前用户的根目录下应该可以看到一个  .czrc的文件了

然后你切换到你的git 工程下 ,在当你需要使用 git commit 的地方更换成 git cz就能显示出 commit 的交互界面

局部安装:

1.直接 cd到你的git工程下

2.commitizen init cz-conventional-changelog  --save --save-exact  安装规范文件，如果你的项目本身就是 node系列的 如 web

前端项目 ，你的项目下应该是有个 package.json文件的，此时你运行 上面的命令不会报错 直接成功,但如果你的项目是 ios 、Android

工程根目录下没有 package.json的话你就需要 npm init 一下，然后会看到一个package.json的目录

3.commitizen init cz-conventional-changelog  --save --save-exact  此时你会发现又多了个nodes_modules文件夹没办法 ,你两个

文件你应该不会导入到工程中吧，直接加入到 gitignore文件中去好了

　　　　所以推荐全局安装 ,好的规范应该用在所有的工程上.

你是否注意到，当你执行 git cz后的那些提示信息，按照一步一步填写 ，最终会生成如下格式的提示信息

<type>(<scope>) : <subject>

<空行>

<body>

<空行>

<footer>

其中 type 的值可以有很多，下面有几个我们常用到的
      . feat :新功能

. fix :修复bug

. doc : 文档改变

. style : 代码格式改变

. refactor :某个已有功能重构

.perf :性能优化

.test :增加测试

. build :改变了build工具 如 grunt换成了 npm

.revert: 撤销上一次的 commit

scope :用来说明此次修改的影响范围 可以随便填写任何东西，commitizen也给出了几个 如：location 、browser、compile，不过我推荐使用

all ：表示影响面大 ，如修改了网络框架  会对真个程序产生影响

loation： 表示影响小，某个小小的功能

module：表示会影响某个模块 如登录模块、首页模块 、用户管理模块等等

subject: 用来简要描述本次改动，概述就好了

body:具体的修改信息 应该尽量详细

footer：放置写备注啥的，如果是 bug ，可以把bug id放入

最后生成的 commit 信息大概是这样的  简洁又明了

那现在来讲讲第二种 ：git 设置模板

　　  步骤如下：

1.首先建立一个模板文件 最好直接在用户根目录下建(为啥？  稍后解释)

　　　　　　如：建立  vim  .template_git

如果 按 i 编辑  ，输入自己想要的规范 ，刚上面说了AngularJS的 commit规范很好，那我们应该模拟它的

然后保存 推出

2.git config --global commit.templte  模板文件名,  我的模板文件是 .template_git  所有我直接

git config --global commit.template  /Users/tao/.template_git   （PS:一定要是绝对路径,因为commit 的时候git会去到根据具体的路径名去加载模板）

其中 --global 参数是为了指明是全局配置git，就是影响你电脑上的所有git工程,当然你也可以直接去对应的工程根目录下

执行不带 --global参数的命令  则只会影响当前工程  （还是推荐全局 ，好东西要一起用）

　　　　配置完成后 你直接在需要commit的时候输入 git commit

然后会出来一些文本提示 只要大家都按照上面的格式填写我们就也能有和AngularJS一样美观的提交信息了 ，这里有个按照AngularJS规范编写的模板文件

可以直接下载下来配置

PS：对于上面两种方式 个人觉得 commitizen 无疑是利器了，能用尽量用，但有些开发小伙伴可能对纯命令的形式不太喜欢，或者就是不会git 命令

也有些正在使用 如sourceTree一样有着界面的git工具，这个时候就可以采用 git 配置模板的方式了, 由于sourceTree默认也会去加载git全局配置的

commit模板(全局配置的重要性)，而且这个配置文件还只能在当前用户根目录的下,这也是为什么上面说要在用户根目录下建配置文件的原因

老鸟都应该注意的git 提交规范的更多相关文章

  1. git 提交规范

    git 提交规范 前言 无规矩不成方圆,编程也一样. 如果你有一个项目,从始至终都是自己写,那么你想怎么写都可以,没有人可以干预你.可是如果在团队协作中,大家都张扬个性,那么代码将会是一团糟,好好的项 ...

  2. 项目工程化之git提交规范以及 CHANGELOG生成

    事先声明,本文是参考了其他大神的博客之后自己尝试的记录,具体可以参考如下 链接 先说说git 提交规范把,这里基本都是这个工具 cz-customizable 1,安装 npm install cz- ...

  3. 开发中的你的Git提交规范吗？

    1. 前言 目前大部分公司都在使用Git作为版本控制,每个程序员每天都要进行代码的提交.很多开发者也包括我自己,有时候赶时间或者图省事,就这么提交: git commit -m "修改bug ...

  4. 前端规范之Git提交规范（Commitizen）

    代码规范是软件开发领域经久不衰的话题,几乎所有工程师在开发过程中都会遇到或思考过这一问题.而随着前端应用的大型化和复杂化,越来越多的前端团队也开始重视代码规范.同样,前段时间,笔者所在的团队也开展了一 ...

  5. 利用shell脚本生成CHANGELOG.md（包含git提交规范）

    前言 我们经常看到github上面有很多CHANGELOG.MD包含版本的更新信息,如果我们的git提交能遵循一定的规范,那么使用gitlog就能很方便的生成它 生成结果  shell脚本 http ...

  6. 关于Git提交规范

    自古至今,无规矩不成方圆. Git提交也有其规范,业内做的比较好的,比较具有参考价值的就是Angular的提交. Angular提交规范: <type>(<scope>): & ...

  7. 你可能会忽略的 Git 提交规范

    一.为什么需要规范? 无规矩不成方圆,编程也一样. 如果你有一个项目,从始至终都是自己写,那么你想怎么写都可以,没有人可以干预你.可是如果在团队协作中,大家都张扬个性,那么代码将会是一团糟,好好的项目 ...

  8. Git提交规范

    Commit message 的格式 每次提交,Commit message 都包括三个部分:Header,Body 和 Footer. <type>(<scope>): &l ...

  9. Git提交代码规范 而且规范的Git提交历史，还可以直接生成项目发版的CHANGELOG（semantic-release）

    Git提交代码规范 - 木之子梦之蝶 - 博客园 https://www.cnblogs.com/liumengdie/p/7885210.html Commit message 的格式 Git 每次 ...

随机推荐

  1. 内存排查 valgrind

    内存问题排查工具 --- valgrind 1. 概述 2. Valgrind 3. 内存泄漏监测 3.1. 示例代码 3.2. 编译它 3.3. 用Valgrind监测进程的内存泄漏 4. 悬挂指针 ...

  2. 深入struts2.0(五)--Dispatcher类

    1.1.1       serviceAction方法 在上个Filter方法中我们会看到例如以下代码: this.execute.executeAction(request, response, m ...

  3. asp.net 获得客户端 mac 地址

    using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.We ...

  4. iOS程序发布时出现your application is being uploaded解决办法

    当用Xcode发布app时候出现“your application is being uploaded”或者用Application Loader 一直出现“ 正在通过ITUNES STORE进行鉴定 ...

  5. IOS开发-Swift新语言初见

    Safe Swift pairs increased type safety with type inference, restricts direct access to pointers, and ...

  6. 省钱加油(Fuel Economy)题解

    题目 农夫约翰决定去做一个环游国家旅行,为了不让他的奶牛们感到孤单,于是他决定租一辆货车带领他的奶牛们一起去旅行.这辆货车的油箱最多可以承载G 个单位的油,同时为了简化问题,规定每一个单位的油可以行使 ...

  7. tomcat的webapps文件夹下放更新后的项目就訪问不了

    昨天给同事更新完程序,同事说更新后的程序訪问不了.它曾经的程序叫tj52,更新后的程序叫webapp.也就是tomcat的文件夹有两个文件架,一个叫webapp,一个叫tj52.最后另外一同事给了解决 ...

  8. Webservice中使用Session、Application

    原文:Webservice中使用Session.Application 在Asp.Net 2.0里,已经能够在WebMethod里使用 Session . Application 这种服务器变量了.一 ...

  9. 新服务器部署sqlserver之前的准备

    当你有一个新的服务器需要部署的时候,如果没有部署过的经验很可能会走很多误区,并且给以后的维护工作加大难度,我在这就把我部署服务器的一些经验跟大家分享一下. 1.登陆服务器以后先将物理盘按照64k为分配 ...

  10. 超酷的jQuery百叶窗图片滑块实现教程

    原文:超酷的jQuery百叶窗图片滑块实现教程 今天我们要来分享一款基于jQuery的百叶窗焦点图插件,也可以说是图片滑块插件.这种jQuery焦点图插件的应用非常广泛,在早些年前,我们需要用flas ...