Git提交规范

首先我们看一下完整的一个提交信息:

feat(用户授权): 添加第三方授权

1. 第三方授权配置接口
2. 第三方授权token管理
3. 第三方授权权限控制

BREAKING CHANGE: 第三方授权方式

我们可以将一个提交信息分成三个部分:

git

Header分成三个部分

  • type（类型，必填）
  • scope（影响范围，选填）
  • short description（简单描述，必填)

type

type主要有以下几种类型:

  • feat：新功能（feature）
  • fix：修补bug
  • docs：文档（documentation）
  • style： 格式（不影响代码运行的变动,空格,格式化,等等）
  • refactor：重构（即不是新增功能，也不是修改bug的代码变动）
  • perf: 性能 (提高代码性能的改变)
  • test：增加测试或者修改测试
  • build: 影响构建系统或外部依赖项的更改(maven,gradle,npm 等等)
  • ci: 对CI配置文件和脚本的更改
  • chore：对非 src 和 test 目录的修改
  • revert: Revert a commit

scope

选填，如例子中的(用户授权)

short description

简单描述，必填，不超过50个字，详细内容可在body去写。

Body

对提交的详细描述，可多行

如果本次提交出现与上一个版本不兼容的情况，需要编写Footer，以BREAKING CHANGE开头。

IDEA插件

使用idea提交的同学可以安装这款插件commit-template-idea-plugin

idea

项目结构
nacos-server