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

一直是 ESLint 的忠实用户，深知规范的重要性。然而，在新项目交接中，我被 Git Commit 规范逼疯了。才意识到自己的疏忽，于是便有了一探究竟的想法。

目前创新互联建站已为数千家的企业提供了网站建设、域名、虚拟主机、绵阳服务器托管、企业网站设计、昆都仑网站维护等服务，公司将坚持客户导向、应用为本的策略，正道将秉承"和谐、参与、激情"的文化，与客户和合作伙伴齐心协力一起成长，共同发展。

一、为什么需要规范?

无规矩不成方圆，编程也一样。

如果你有一个项目，从始至终都是自己写，那么你想怎么写都可以，没有人可以干预你。可是如果在团队协作中，大家都张扬个性，那么代码将会是一团糟，好好的项目就被糟践了。不管是开发还是日后维护，都将是灾难。

这时候，有人提出了何不统一标准，大家都按照这个标准来。于是 ESLint，JSHint 等代码工具如雨后春笋般涌现，成为了项目构建的必备良品。

Git Commit 规范可能并没有那么夸张，但如果你在版本回退的时候看到一大段糟心的 Commit，恐怕会懊恼不已吧。所以，严格遵守规范，利人利己。

二、具体规则

先来看看公式：

 
 
 
    
  
  
  
  1. ():  
    2.

type

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

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

scope

用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

subject

是 commit 目的的简短描述，不超过50个字符。

  1. 以动词开头，使用***人称现在时，比如change，而不是changed或changes
  2. ***个字母小写
  3. 结尾不加句号(.)

三、异常处理

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

 
 
 
    
  
  
  
  1. INVALID COMMIT MSG: does not match "(): " ! 
    2. 
  
  
  
  2. jartto:fix bug 
    3.

这里之所以报出这个警告，是因为我的提交出现了两个问题：

  • 其一，使用了规范外的关键字;
  • 其二，很细节的问题，jartto：后少了空格;

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

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

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

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

其实并不复杂，我们只需要这样做:

1、将当前分支无关的工作状态进行暂存

 
 
 
    
  
  
  
  1. git stash 
    2.

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

 
 
 
    
  
  
  
  1. git rebase 9633cf0919^ --interactive 
    2.

3、找到需要修改的 commit ,将首行的 pick 改成 edit

4、开始着手解决你的 bug

5、 git add 将改动文件添加到暂存

6、 git commit –amend 追加改动到提交

7、git rebase –continue 移动 HEAD 回***的 commit

8、恢复之前的工作状态

 
 
 
    
  
  
  
  1. git stash pop 
    2.

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

五、项目中使用

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

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

1.首先，安装插件：

 
 
 
    
  
  
  
  1. npm install --save-dev validate-commit-msg 
    2.

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

 
 
 
    
  
  
  
  1. { 
    2. 
  
  
  
  2.   "types": ["feat", "fix", "docs", "style", "refactor", "perf", "test", "build", "ci", "chore", "revert"], 
    3. 
  
  
  
  3.   "scope": { 
    4. 
  
  
  
  4.     "required": false, 
    5. 
  
  
  
  5.     "allowed": ["*"], 
    6. 
  
  
  
  6.     "validate": false, 
    7. 
  
  
  
  7.     "multiple": false 
    8. 
  
  
  
  8.   }, 
    9. 
  
  
  
  9.   "warnOnFail": false, 
    10. 
  
  
  
  10.   "maxSubjectLength": 100, 
    11. 
  
  
  
  11.   "subjectPattern": ".+", 
    12. 
  
  
  
  12.   "subjectPatternErrorMsg": "subject does not match subject pattern!", 
    13. 
  
  
  
  13.   "helpMessage": "", 
    14. 
  
  
  
  14.   "autoFix": false 
    15. 
  
  
  
  15. } 
    16.

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

 
 
 
    
  
  
  
  1. { 
    2. 
  
  
  
  2.   "config": { 
    3. 
  
  
  
  3.     "validate-commit-msg": { 
    4. 
  
  
  
  4.       /* your config here */ 
    5. 
  
  
  
  5.     } 
    6. 
  
  
  
  6.   } 
    7. 
  
  
  
  7. } 
    8.

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

 
 
 
    
  
  
  
  1. { 
    2. 
  
  
  
  2.   … 
    3. 
  
  
  
  3.   "config": { 
    4. 
  
  
  
  4.     "ghooks": { 
    5. 
  
  
  
  5.       "pre-commit": "gulp lint", 
    6. 
  
  
  
  6.       "commit-msg": "validate-commit-msg", 
    7. 
  
  
  
  7.       "pre-push": "make test", 
    8. 
  
  
  
  8.       "post-merge": "npm install", 
    9. 
  
  
  
  9.       "post-rewrite": "npm install", 
    10. 
  
  
  
  10.       … 
    11. 
  
  
  
  11.     } 
    12. 
  
  
  
  12.   } 
    13. 
  
  
  
  13.   … 
    14. 
  
  
  
  14. } 
    15.

在 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 ：

 
 
 
    
  
  
  
  1. npm install -g conventional-changelog 
    2. 
  
  
  
  2. cd jartto-domo 
    3. 
  
  
  
  3. conventional-changelog -p angular -i CHANGELOG.md -w 
    4.

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

 
 
 
    
  
  
  
  1. { 
    2. 
  
  
  
  2.   "scripts": { 
    3. 
  
  
  
  3.     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0" 
    4. 
  
  
  
  4.   } 
    5. 
  
  
  
  5. } 
    6.

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

 
 
 
    
  
  
  
  1. npm run changelog 
    2.

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

八、总结

看完文章，你还会如此放荡不羁吗?你还会随心所欲的编写 Commit 吗?你还会如此 git commit -m "hello jartto"提交吗?

答案是否定的，因为使用了钩子函数，你没有机会了，否则将是无穷无尽的恢复 Commit。这倒可以养成良好的提交习惯~~

分享名称：你可能会忽略的Git提交规范
当前链接：http://www.csdahua.cn/qtweb/news26/236076.html

网站建设、网络推广公司-快上网，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 快上网

成都快上网为您推荐相关内容

电子商务知识

行业网站建设

营销推广　　 　响应式网站　　 　和正源建设　　 　移动服务器托管　　 　四川网站建设　　 　乐山电信机房　　 　成都发电机租用　　 　商城系统开发　　 　广告品牌策划设计　　 　网站改版维护　　 　云服务器香港　　 　成都酒店服定制　　 　成都响应式网站建设　　 　四川白乌鱼　　 　成都网站设计　　 　都江堰网站建设　　 　成都广告招牌　　 　资阳做网站　　 　乐山主机托管　　 　广安网站设计