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

二、具体规则

先来看看公式：

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

• type
  • 用于说明 commit 的类别，只允许使用下面7个标识。

feat：新功能（feature）<br>fix：修补bug<br>docs：文档（documentation）<br>style： 格式（不影响代码运行的变动）<br>refactor：重构（即不是新增功能，也不是修改bug的代码变动）<br>test：增加测试<br>chore：构建过程或辅助工具的变动<br>

• scope
  • 用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。
• subject
  • 是 commit 目的的简短描述，不超过50个字符。

1. 以动词开头，使用第一人称现在时，比如change，而不是changed或changes<br>2. 第一个字母小写<br>3. 结尾不加句号（.）<br>

规范参考自阮一峰老师的文章：Commit message 和 Change log 编写指南。

三、异常处理

我们先来看看这个异常提醒：

INVALID COMMIT MSG: does not match "<type>(<scope>): <subject>" !<br>jartto:fix bug<br>

这里之所以报出这个警告，是因为我的提交出现了两个问题：
其一，使用了规范外的关键字；
其二，很细节的问题，jartto：后少了空格；

这时候我才回忆起来，当时提交一直失败，情急之下直接强制提交，所以以后的提交都会抱出这个异常。大致意思就是：

你的之前的 Commit 不合格～你的之前的 Commit 不合格～你的之前的 Commit 不合格

这时候就很烦了，我们只能去将之前的错误修正，那么如何操作呢？

四、如何修改之前的 commit 信息？

其实并不复杂，我们只需要这样做:
1、将当前分支无关的工作状态进行暂存

2、将 HEAD 移动到需要修改的 commit 上

git rebase 9633cf0919^ --interactive<br>

3、找到需要修改的 commit ,将首行的 pick 改成 edit
4、开始着手解决你的 bug
5、 git add 将改动文件添加到暂存
6、 git commit –amend 追加改动到提交
7、git rebase –continue 移动 HEAD 回最新的 commit
8、恢复之前的工作状态

大功告成，是不是想把整个 Commit 都修改一遍，逃～

此处参考自：修改 Commit 日志和内容

五、项目中使用

这时候问题又来了，为什么我提交的时候会有警告，这个又是如何做到的呢？

这时候，我们需要一款 Node 插件 validate-commit-msg 来检查项目中 Commit message 是否规范。

1.首先，安装插件：

npm install --save-dev validate-commit-msg<br>

2.使用方式一，建立 .vcmrc 文件：

{<br> "types": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "build", "ci", "chore", "revert"],<br> "scope": {<br> "required": false,<br> "allowed": ["*"],<br> "validate": false,<br> "multiple": false<br> },<br> "warnOnFail": false,<br> "maxSubjectLength": 100,<br> "subjectPattern": ".+",<br> "subjectPatternErrorMsg": "subject does not match subject pattern!",<br> "helpMessage": "",<br> "autoFix": false<br>}<br>

3.使用方式二：写入 package.json

{<br> "config": {<br> "validate-commit-msg": {<br> /* your config here */<br> }<br> }<br>}<br>

4.可是我们如果想自动使用 ghooks 钩子函数呢？

{<br> …<br> "config": {<br> "ghooks": {<br> "pre-commit": "gulp lint",<br> "commit-msg": "validate-commit-msg",<br> "pre-push": "make test",<br> "post-merge": "npm install",<br> "post-rewrite": "npm install",<br> …<br> }<br> }<br> …<br>}<br>

在 ghooks 中我们可以做很多事情，当然不只是 validate-commit-msg 哦。

更多细节请参考：validate-commit-msg

六、Commit 规范的作用

1.提供更多的信息，方便排查与回退；
2.过滤关键字，迅速定位；
3.方便生成文档；

七、生成 Change log

正如上文提到的生成文档，如果我们的提交都按照规范的话，那就很简单了。生成的文档包括以下三个部分：

• New features
• Bug fixes
• Breaking changes.

每个部分都会罗列相关的 commit ，并且有指向这些 commit 的链接。当然，生成的文档允许手动修改，所以发布前，你还可以添加其他内容。

这里需要使用工具 Conventional Changelog 生成 Change log ：

npm install -g conventional-changelog<br>cd jartto-domo<br>conventional-changelog -p angular -i CHANGELOG.md -w<br>

为了方便使用，可以将其写入 package.json 的 scripts 字段。

{<br> "scripts": {<br> "changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"<br> }<br>}<br>

这样，使用起来就很简单了：

到这里，我们所有的问题都搞明白了，

来源： http://blog.didispace.com/git-commit-specification/

---

搞代码网（gaodaima.com）提供的所有资源部分来自互联网，如果有侵犯您的版权或其他权益，请说明详细缘由并提供版权或权益证明然后发送到邮箱[email protected]‍，我们会在看到邮件的第一时间内为您处理，或直接联系QQ：872152909。本网站采用BY-NC-SA协议进行授权
转载请注明原文链接：你可能会忽略的 Git 提交规范

喜欢 (0)赏

[搞代码]

分享 (0)