banner
Tenifs

Tenifs

雄关漫道真如铁,而今迈步从头越。
github
zhihu
email

Angular 提交信息规范

提交格式:

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

每次提交的信息不超过 100 个字符

提交信息包括 header、body 和 footer,其中必须要包含 header

header#

格式如下:

<type>(<scope>): <subject>

其中,scoop 可选,范围可以是任何指定提交更改位置的内容

type 指定为下面其中的一个:

  • build:对构建系统或外部依赖进行了修改
  • ci:对 CI 配置文件或脚本进行了修改
  • docs:对文档进行了修改
  • feat:添加新的功能
  • fix:修复 Bug
  • pref:提高性能的代码更改
  • refactor:代码重构
  • style:不影响代码含义的修改,例如空格、格式化、缺失分号等
  • test:增加测试或修改测试代码

subject 对本次修改进行简洁的叙述,通常使用以下原则:

  • 使用命令语气,现在时态
  • 不要大写首字母
  • 不在末尾添加句号

body#

和 subject 设置类似,使用命令语气、现在时态
一般要包含修改的动机和之前行为的对比

所有不兼容修改都必须在 footer 中作为中断更改块提到,以 BREAKING CHANGE: 开头,后跟一个空格或者两个换行符,其余的信息就是对此次修改的描述,修改的理由和修改的注释

BREAKING CHANGE: isolate scope bindings definition has changed and
    the inject option for the directive controller injection was removed.

    To migrate the code follow the example below:

    Before:

    。。。
    。。。

    After:

    。。。
    。。。

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

如果本次提交目的是修改 issue 的话,需要在 footer 中引用该 issue

以关键字 Closes 开头,例如:

Closes #234

多个 issue 用逗号进行分隔

Closes #123, #245, #992

当此次提交包含回滚 (revert) 操作,那么 footer 以 revert: 开头,同时在 body 中添加 This reverts commit hash,其中 hash 值表示被回滚前的提交

revert:<type>(<scope>): <subject>
<BLANK LINE>
This reverts commit hash
<other-body>
<BLANK LINE>
<footer>

参考资料#

加载中...
此文章数据所有权由区块链加密技术和智能合约保障仅归创作者所有。