Git Commit 标准化
1 前言
Git Commit Message 应该清晰明了，要用精简的语言说明本次提交的目的，其主要作用是为
了后续的搜索、版本的回滚、合并冲突的追溯等操作。
我们在开发时一直以来对 Git Commit 格式有个约定俗称的要求，所以就没落实明确的规范。
因为没有明确的规范，就会导致提交的消息较为随意。甚至出现「“.”、”Update”」这样的消息。
直到我在 GitHub 上发现了这条 Commits 时，才意识到提交信息也该规范起来。
以下图举例，当代码出现 Bug 时，应该回滚到哪个版本？
回滚到 “朕与将军解战袍，芙蓉暖帐度春宵” 吗？
这条记录所变更的内容是啥，看概要我一概不知。 ︿(￣︶￣)︿
为了解决规范问题，我参考了一些的开源项目，当发现 commitizen 库时，才知道好多大型开
源（AngularJS、VueJS）项目早已使用了它。所以在接下来我会介绍一下 commitizen 工具所
使用 Google AngularJS 规范。
2 规范介绍
这次主要介绍 AngularJS 的规范，它是由 Google 推出的一套提交消息规范标准，也是目前使
用范围最广的规范。有一套合理的手册也较为系统化；并且还有配套的工具可以供我们使用。
说白了，规范就是用工具进行强约束。单看规范比较简单，所以先让大家先看看面，知道他的
大体规则后，在来讲细节。
规范执行方案如下：
既然有了方案，就会按照某些规则执行，以下是 Google AnguarJS 规范的要求：
规范目标
- 允许通过脚本生成 CHANGELOG.md
- 可以通过范围的关键词，快速的搜索到指定版本
git log HEAD --grep feat(package.json) # 在package.json文件里新增的特性。
格式要求
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
- 消息只占用一行，任何行都不能超过 100 个字符
- 允许使用 GitHub 以及各种 Git 工具阅读消息
- 提交消息由页眉、正文和页脚组成，由空行分隔
<type>
代表某次提交的类型，比如是修复一个 bug 或是增加一个 feature，类型如下：
类型 描述
<scope>
范围可以是指定提交更改位置的任何内容，如：
- 对 package.json 文件新增依赖库，chore(package.json): 新增依赖库
- 或对代码进行重构，refacto(weChat.vue): 重构微信进件
<subject>
如果没有更合适的范围，可以直接写提交内容
Commit 实战
提交一条依赖库变更，type 为 chore（增加依赖库）；等提交完成后，使用 Git 工具进行搜索。
此时搜索类型是 chore(package.json)，所以就能知道 package.json 文件所有的历史变更。
# 新增一条 Commit 记录
git commit -m 'chore(package.json): 新增 AngularJS 规范，Commit 时会自动调用钩子（GitHook）来判断 Message 是否有效' # 搜索跟 package.json 文件相关的历史记录
git log HEAD --grep chore(package.json)
3 工具介绍
因为是 Google AngularJS 的标准规范，所以提供了多种工具。如生成 CHANGELOG.md，提
交工具，检查工具。
工具列表：
1. 提交工具 commitizen，如果是初学者，可以使用 commitizen 帮助我们生成消息
2. 生成 CHANGELOG.md，把 Git Commit Message 的消息自动生成 CHANGELOG.md
3. Message 检查，是否有 “不符合” 规范的内容，可以在 GitHook 中使用
提交以及检查工具相对来说简单，大家自学即可，所以我以生成 CHANGELOG.md 举例。
# 安装 CHANGELOG 生成器
yarn global add standard-version # 生成文档
standard-version --first-release
文档生成后，当前目录下就有 CHANGELOG.md 文件了，如果是 Node 项目，也会自动更新
package.json version 的版本号
这是根据 Git Commit Message 历史记录所生成的 CHANGELOG.md，在也不用手写了。(￣▽￣)"
4 参考链接
commitizen
https://github.com/commitizen/cz-cli
https://github.com/conventional-changelog/conventional-changelog
https://github.com/marionebl/commitlint
中文规范
https://github.com/feflow/git-commit-style-guide
AngularJS 规范
https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.greljkmo14y0
https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#toc10
Git Commit 标准化的更多相关文章
- git commit 、CHANGELOG 和版本发布的标准自动化
一直以来,因为团队项目迭代节奏很快,每次发布的更新日志和版本更新都是通过人肉来完成的.有时候实在忙的团团转,对于手动的写这些更新信息就显得力不从心了.对于团队新来的小伙伴,有时候遇到些紧急情况,就更显 ...
- [译]How to Write a Git Commit Message
原文: http://chris.beams.io/posts/git-commit/ 介绍:为什么好的commit message很重要 你浏览项目commit message的时候或多或少会有些困 ...
- xcode svn commit is not under version control (1) & git commit
使用Xcode提交一个第三方库时,由于包含资源文件,总是提交不了,提示报错:XXX commit is not under version control (1) 网上查了下,得知 xcode对于sv ...
- linux显示git commit id，同时解决insmod模块时版本不一致导致无法加载问题
linux内核默认会包含git的commit ID. 而linux的内核在insmod模块时,会对模块和内核本身的版本做严格的校验.在开发产品时,改动内核后,由于commit ID变更,会导致linu ...
- git commit 代码时提示： Warning: Your console font probably doesn‘t support Unicode.
git 提交代码是会遇到以下问题, git commit 代码时提示: Warning: Your console font probably doesn‘t support Unicode. If ...
- [译]git commit --amend
git commit --amend命令用来修复最近一次commit. 可以让你合并你缓存区的修改和上一次commit, 而不是提交一个新的快照. 还可以用来编辑上一次的commit描述. 记住ame ...
- [译]git commit
git commit git commit命令提交stage区的快照到项目历史中去(HEAD). 被提交的快照被认为是一个项目的安全版本. Git不会修改他们, 除非你显示的要求了. 和git add ...
- git commit --amend
任何时候,你都有可能需要撤消刚才所做的某些操作.接下来,我们会介绍一些基本的撤消操作相关的命令.请注意,有些撤销操作是不可逆的,所以请务必谨慎小心,一旦失误,就有可能丢失部分工作成果. 有时候我们提交 ...
- Git commit 常见用法
Git commit git commit 主要是将用户通过git add命令添加到暂存区里的改动给提交到本地的版本库,关于版本库的构成可以查看我先前的笔记. 每次提交我们都会在本地版本库生成 ...
随机推荐
- 元素的定位tag_name，link_text，class_name
tag_name 就是根据HTML的标签的名称来定位的: 案例:打开我要自学网,会有用户名和密码的输入框 例如:拿51zxw.net为例 from time import sleep #加载浏览器驱动 ...
- windows下多个文件合并成一个文件
如果你拿到的是一堆文件,那么你想把它合并成一个文件来使用,那么按下面的步骤,轻轻松松就可以搞定. 第一步:把所有要合并的文件放到同一个文件下面 第二步:在CMD里面进入到你的文件目录 第三步:输入如下 ...
- hdoj2859（矩阵DP）
题目链接:http://acm.hdu.edu.cn/showproblem.php?pid=2859 思路: 第一次碰到这种矩阵上的DP题,想了半天也没想明白.本来想用子矩阵的左上角坐标和右下角坐标 ...
- 第八章 高级搜索树 (xa1)红黑树：动机
- The Last Stand
The Last Stand https://ac.nowcoder.com/acm/contest/303/L 时间限制:C/C++ 1秒,其他语言2秒 空间限制:C/C++ 262144K,其他语 ...
- iOS 11 scroll滚动偏移，tableview偏移44，获取view的宽和高
1. tableview 的头部 有44的偏移量 1>.设置 tableview的 属性 tableView.scrollIndicatorInsets = UIEdgeInsets.zero ...
- [leetcode]347. Top K Frequent Elements 最高频的前K个元素
Given a non-empty array of integers, return the k most frequent elements. For example,Given [1,1,1,2 ...
- CentOS7下部署NTP Server
系统环境:CentOS Linux release 7.4.1708 (Core) 3.10.0-693.el7.x86_64 软件版本:chrony-3.1-2.el7.centos.x86_64 ...
- msys2 显示git branch
在.bashrc或.bash_profile中添加以下内容 function parse_git_branch () { git branch 2> /dev/null | sed -e '/^ ...
- Notepad++ 中如何将代码格式化
Notepad++ 中如何将代码格式化 在阅读别人的代码时偶尔会遇到格式很乱,阅读起来很费劲的情况,若手动改,很容易出错且很费时间,这时可以借助一些专业的编辑器来格式化代码,NotePad++是一 ...