Skip to content

Latest commit

 

History

History
73 lines (42 loc) · 2.35 KB

commitlint.md

File metadata and controls

73 lines (42 loc) · 2.35 KB

Commit Message 标准格式

AngularJS的Commit规范

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

上面是一次Commit后Message格式规范,分成标题,内容详情,结尾三个部分,各有各的用处,没有多余项。

头部

即首行,是可以直接在页面中预览的部分,入上面图中所示,一共有三个部分,,,含义分别如下

Type

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • revert:回滚
  • config:构建过程或辅助工具的变动
  • chore:其他改动
Scope

用来说明本次Commit影响的范围,即简要说明修改会涉及的部分。这个本来是选填项,但从AngularJS实际项目中可以看出基本上也成了必填项了。

Subject

用来简要描述本次改动,概述就好了,因为后面还会在Body里给出具体信息。并且最好遵循下面三条:

  • 以动词开头,使用第一人称现在时,比如change,而不是changed或changes
  • 首字母不要大写
  • 结尾不用句号(.)
Body
里的内容是对上面subject里内容的展开,在此做更加详尽的描述,内容里应该包含修改动机和修改前后的对比。
Footer

footer里的主要放置不兼容变更Issue关闭的信息,参考下面两个例子

img

image

img

image

Revert

此外如果需要撤销之前的Commit,那么本次Commit Message中必须以revert:开头,后面紧跟前面描述的Header部分,格式不变。并且,Body部分的格式也是固定的,必须要记录撤销前Commit的SHA值。

ATTENTION:

1、注意type和内容之间的空格;

2、请不要使用--no-verify参数忽略掉提交信息