git commit提交规范

4,127 阅读2分钟

本文分享一个用于提交规范的小插件,安装方便也很实用。

插件介绍

作为一名程序员,提交代码是我们每天都要做很多次的事,不知道你们的团队有没有git提交的规范呢。如果有,那么今天分享的这个插件将特别实用;如果没有,那么希望看了这篇文章,可以帮助你形成提交规范

俗话说:没有规矩不成方圆。这句话在我们日常的开发工作中也同样适用,有成文的提交规范,不仅可以方便后期的代码review,在代码出现问题的时候可以根据提交的log快速定位到某次提交,甚至可以解析提交的message,自动化关闭bug,自动发送邮件等等。根据业务需求,还可以做很多提高效率的事,所以前提是我们需要把git提交规范做好。

先搞明白我们为什么要做这个规范,再来看看,本文分享的这个插件能为我们带来什么便捷的功能呢,下面直接看图说话吧:

第一步:

第二步:

第三步:

支持字段

  • feat: 新功能(feature)
  • fix: 修补问题
  • docs: 更新文档
  • refactor: 重构(即不是新增功能,也不是修改bug的代码变动)
  • build: 构建编译相关的改动
  • chore: bump version to [版本号]
  • test: 增加测试
  • style: 格式变更(不影响代码运行的变动)

其实这里也就是一个成文的提交规范,上面支持的这些字段,也基本满足了我们日常开发提交代码的大部分情况了。

安装和使用

安装条件

  • node
  • npm

安装方法

> npm i safecommit -g

使用方法

  1. 在git目录下
  2. git add
  3. 在命令行里输入 git sc,就会出现选择支持字段选择,后面有中文,大家可以根据自己需要选择
  4. 输入commit的内容
  5. 填写更新的文件,也可以不填直接回车即可
  6. 最后push即可

注意:如果您习惯使用SourceTree等GUI工具,那么请您在您的项目中至少第一次使用git sc进行提交,此后的所有操作都可以在您的GUI工具中进行。

这一段“注意”是官方给的说法,可是我亲测无效,不知道是不是对SourceTree版本有什么限制,或者我的打开方式不对。希望看到这篇文章的小伙伴都安装一下这个插件试试,如果你可以在SourceTree中使用,记得要告诉我哈~

文献

www.npmjs.com/package/saf…