提交规范

Hexiaopi大约 2 分钟

Commit Message

Git每次提交代码，都需要写Commit message，好的规范例如：Angular规范，可以帮助我们：

根据摘要信息就可以知道每次变更哪些内容
可以过滤某些commit，例如只关注新增加的功能
根据commit生成Change log

在Angular规范中，Commit Message包含三个部分：Header、Body、Footer，格式如下：

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

提示

<scope>必须用括号()括起来
<type>(<scope>)后必须紧跟冒号，冒号后紧跟空格
<body>和<footer>之前两个空行也必须要有

建议每行字符控制在72个字符之内

示例：

fix($compile): couple of unit tests for IE9

type（必须项）

type用来说明commit的类型：

feat：新功能（feature）
fix：修补bug
perf: 提高代码性能的变更
docs：文档（documentation）
style：格式（不影响代码运行的变动）
refactor：优化重构（即不是新增功能，也不是修改bug的代码变动，例如：变量重命名、冗余代码删除、代码简化或增加注释）
test：增加测试
chore：构建过程或辅助工具的变动

type为feat和fix的可以出现在Change log中，其他建议不要

scope（可选项）

scope用于说明commit影响范围，视项目不同而不同。如果项目包含多个组件，建议每个组件作为scope 如果项目只有一个组件，建议根据分成作为scope，例如数据层、控制层、视图层

subject（可选项）

subject是commit的简短描述，建议：
以动词开头、使用第一人称现在时
第一个字母小写
结尾不加句号

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

用来说明本次commit导致的后果，常用来说明：
不兼容的改动，以BREAKING CHANGE开头
关闭的Issue列表示例：

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.

或

Closes #123, #245, #992

Change Log

我们可以使用一些工具根据git提交记录自动生成CHANGELOG变更日志，例如： git-chglog，本项目的CHANGELOG就是使用该工具自动生成，非常方便。

git-chglog -o CHANGELOG.md

SemVer

可以使用gsemver工具根据git提交记录生成下一个版本

参考文献

约定式提交