git提交规则

对于IT人员来说GitHub,相信大家都不陌生,本文主要讲解使用Git命令提交时的message规范。对于一个英文水平有限的IT人员在项目中很多时候使用git commit, message往往会写的不尽如人意,或者当你使用git log时往往不知道之前提交的是什么东西,修改了什么,这样对以后的查看很不友好。git 提交有一个成熟的工具(Commitizen),本文也将介绍使用(Commitizen)来规范我们的提交信息。 Commitizen网址: link: https://www.npmjs.com/package/commitizen

简单的使用Commitizen

  1. 安装Commitizen

    1
    npm install -g commitizen
  2. 进入我们的项目根目录,运行如下命令:

    1
    2
    commitizen init cz-conventional-changelog --save --save-exact
    // 之后我们的git commit 都改成git cz
  3. 每次修改完代码后都要先运行

    1
    git add '文件夹路径' //修改后的文件夹,也可以 git add . 来完成本次的添加
  4. 运行命令git cz 就会出现如下图所示:

图中我们可以使用键盘的上下键去选择我们本次提交的类型。类型分为:

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • perf: (改进性能的代码更改)

选择类型之后,命令行提示:

1
2
3
4
5
6
7
8
9
10
 What is the scope of this change //(可选)
//输入变化的范围是什么,或者变化的文件
Write a short, imperative tense description of the change: //(可选)
//本次提交简介
Provide a longer description of the change: //(可选)
//本次提交详细描述
Are there any breaking changes? //(可选)
//是否有重大变化(默认为no,为yes的话可以填写本次重大变化的详情)
Does this change affect any open issues?//(可选)
//是否会影响未解决的问题(默认为no,为yes的话可以填影响的信息)

填写message示例:

push到GitHub后的效果如图:

这样我们的commit message就比较直观。

参考文献


作者信息:宁文飞,人和未来大数据前端工程师