雨凡技术栈

关于git提交规范

良好的Commit Message有利于代码审查，能更快速查找变更记录，并且可以直接生成Change log。

angular规范

为了规范代码提交的说明，这里我们使用angular的规范写法：

<type>(<scope>): <subject> #header
// 空一行
<body>
// 空一行
<footer>
1
2
3
4
5

格式讲解

Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。

总的来说，关键就是header这部分，至于<body>和<footer>可省略

例如:

feat:新增财务报表
1

type

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

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

注意:如果type为feat和fix，则该 commit 将肯定出现在 Change log 之中。其他情况（docs、chore、style、refactor、test）由你决定，要不要放入 Change log，建议是不要。

scope

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

git commit -m "feat(module:user):添加用户模块"
1

此提交记录中的module:user说明提交的代码影响的是user模块内容.

subject

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

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

使用commitizen来执行规范

  1. 全局安装commitizennode模块
npm install -g commitizen
1
  1. 在项目目录下运行命令
commitizen init cz-conventional-changelog --save --save-exact
1
  1. 运行完以上一律使用git cz 代替git commit来提交代码,同时会显示一下选项来自动生成符合格式的commit message.
git cz
cz-cli@3.1.1, cz-conventional-changelog@2.1.0


Line 1 will be cropped at 100 characters. All other lines will be wrapped after 100 characters.

? Select the type of change that you're committing: feat:     A new feature //<type>选择要提交的类型
? What is the scope of this change (e.g. component or file name)? (press enter to skip)  //<scope>这种变化的范围是什么
 <新文件>(Others/Git)
? Write a short, imperative tense description of the change: //<subject>写一个简单的描述
 添加commitMessage
? Provide a longer description of the change: (press enter to skip)  //<body>提供更长的变更描述

? Are there any breaking changes? No //有什么突破性的变化吗
? Does this change affect any open issues? No //这一变化是否影响到尚未解决的问题
[master 2e81117] feat(<新文件>(Others/Git)): 添加commitMessage
 5 files changed, 76 insertions(+), 2 deletions(-)
 create mode 100644 config/sidebarConf/Others/Git/Git.js
 create mode 100644 docs/Others/Git/commitMessage.md
 create mode 100644 "docs/Others/Git/git\345\237\272\347\241\200.md"
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

按照提示,你可以写出规范的message了

参考文章

← 1.持续集成和布署 →