ant design pro git提交error； Angular 团队git提交规范

前言

在使用 ant design pro 时，git 提交报错

> running commit-msg hook: fabric verify-commit

   ERROR  提交日志不符合规范

  合法的提交日志格式如下(emoji 和 模块可选填)：


    💥 feat(模块): 添加了个很棒的功能
    🐛 fix(模块): 修复了一些 bug
    📝 docs(模块): 更新了一下文档
    🌷 UI(模块): 修改了一下样式
    🏰 chore(模块): 对脚手架做了些更改
    🌐 locale(模块): 为国际化做了微小的贡献
    See .github/commit-convention.md for more details.

Angular 规范是目前使用最广的写法，比较合理和系统化，并且有配套的工具。

ant design pro 内置了 fabric 作为了编码规范，fabric 提供了严格但是不严苛的 lint 规则集，包含 eslint，stylelint，prettier 三种工具，可以显著的提升代码质量，规范代码风格。

有几种可以提交的方式：

提交时忽略

git commit -a -m '提交语' --no-verify

卸载插件，需要手动将引入包删除
规范提交
vscode使用插件提交

规范 Commit message 的好处

在开发过程中，Git 每次提交代码，都需要写 Commit message（提交说明），规范的 Commit message 有很多好处：

方便快速浏览查找，回溯之前的工作内容
可以直接从 commit 生成 Change log (发布时用于说明版本差异)

目前我们并没有对 commit message 进行规范，造成以下麻烦：

每个人风格不同，格式凌乱，查看很不方便
部分 commit 没有填写 message，事后难以得知对应修改的作用

规范 Commit message 不仅能解决上述问题，而且基本没有副作用和学习成本，应该尽早加上。

规范使用

每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。

Commit message 不能包含换行符，否则会报 ERROR 提交日志不符合规范

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

其中，Header 是必需的，Body 和 Footer 可以省略。

不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。

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

type

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

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

subject

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

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

Body

Body 部分是对本次 commit 的详细描述，可以分成多行。下面是一个范例。

More detailed explanatory text, if necessary.  Wrap it to 
about 72 characters or so. 

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent

有两个注意点。

（1）使用第一人称现在时，比如使用change而不是changed或changes。

（2）应该说明代码变动的动机，以及与以前行为的对比。

Footer 部分只用于两种情况。

不兼容变动

如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。

BREAKING CHANGE: isolate scope bindings definition has changed.

    To migrate the code follow the example below:

    Before:

    scope: {
      myAttr: 'attribute',
    }

    After:

    scope: {
      myAttr: '@',
    }

    The removed `inject` wasn't generaly useful for directives so there should be no code using it.

关闭 Issue

如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue 。

Closes #234

也可以一次关闭多个 issue 。

Closes #123, #245, #992

Revert

还有一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header。

revert: feat(pencil): add 'graphiteWidth' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

Body部分的格式是固定的，必须写成 This reverts commit <hash>.，其中的hash是被撤销 commit 的 SHA 标识符。

如果当前 commit 与被撤销的 commit，在同一个发布（release）里面，那么它们都不会出现在 Change log 里面。如果两者在不同的发布，那么当前 commit，会出现在 Change log 的Reverts小标题下面。

git commit Examples

修改属于 Button 组件的新特性，新增了 primary 类型的按钮：

git commit -m "feat(Button): 新增 primary 类型按钮"

修改属于全局样式的调整，修改了文字颜色，对应的 issue 编号为 567：
git commit -m "style(Global): 修改文字颜色 close #567"

提交信息必须满足以下正则表达式：

/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|build|ci|chore|types|wip|dep)(\(.+\))?: .{1,50}/

Changelog

后续会从 commit 信息自动生成 changelog ，只有以下类型标签修改会被纳入到 changelog：

feat ：新特性
refactor ：重构
fix ：问题修复
style ：样式改动
types ：类型定义相关
dep ：新增依赖或依赖版本变动
docs ：文档相关
perf : 性能优化
test : 增加测试
chore : 构建过程或辅助工具的变动
revert : 回退版本
build : 打包
ci : 持续集成修改

注意

如果一次修改涉及到多个类型，对比上述编号排序并选择编号最小的，或者选择最贴切的。
在切分支开发时需要注意，目前 merge request 通常没有启用 squash commits ，所以对于暂时不确定是否会被采用的修改，请使用 chore wip 等不会被纳入 changelog 的标签。
对于涉及到某个或多个 issue 的修改，请在提交信息中附带 close #1234 格式的标注。