Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 2.36 KB

git提交规范.md

File metadata and controls

74 lines (49 loc) · 2.36 KB

Git提交格式

本规范从vue和angular规范中修改得来。

一个提交信息包含header、body和footer:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

比如:

docs(changelog): update changelog to beta.5

fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

header

header是必须填写的，其内容包含type、scope和subject三个部分:

type

用于说明本次提交的类别，必须是以下可选类别中的一个:

  • ci: ci配置文件和脚本的变动;
  • chore: 构建系统或辅助工具的变动;
  • polish: 代码或者功能模块的改进和完善;
  • fix: 代码BUG修复;
  • feat: 新功能;
  • perf: 性能优化和提升;
  • refactor: 仅仅是代码变动，既不是修复BUG也不是引入新功能;
  • style: 代码格式调整，可能是空格、分号、缩进等等;
  • docs: 文档变动;
  • test: 补充缺失的测试用例或者修正现有的测试用例;

Scope

影响范围不是必须填写的，其内容可以是任何一个明确的变动地方，比如说某个特定的代码目录或者npm包名等等。

subject

本次提交目的的简短描述，请尽量概要描述，控制内容的长度:

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

body

body其实和header的Subject部分的要求是一样的，不同的是body内容必须包括本次变动的动机和将此与以前的行为进行对比，body部分也不是必须的。

footer

这部分的内容应该包含任何与Breaking Changes相关的信息，与此同时，这部分的内容也可以是GitHub或者GitLab的关闭issue的提交引用，footer部分也不是必须的。

Revert

如果本次提交是一次回滚操作，那么必须以revert:开头，接下来的内容是要回滚的commit的header的内容，body部分的格式是This reverts commit <hash>.，具体的示例如下:

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

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.