规范 Git 提交信息-AngularJS Git Commit Message Conventions

最后更新于:8 天前

​ 在 AngularJS 的规范下写提交信息清晰明了,而 AngularJS 提交信息规范文档却是废话连篇。以下是文档的简要翻译,仅保留有用的内容。


AngularJS Git 提交信息规范

提交信息的格式

<类型>(<范围>): <概括>

<空行>

<主体>

<空行>

<注脚>

消息头

消息头是包括类型、范围、和概括的一行描述内容。

允许的 <类型>

feat (新特性)

fix (漏洞修复)

docs (文档)

style (格式、错别字修改等)

refactor (代码重构)

test (增加测试)

chore (构建过程或辅助工具的变动)

允许的 <范围>

描述了改动影响的范围。在Angular,可以是 $location$browser 等。

如果改动的内容很多,可以用 (*) 来表示。

<概括> 文本

This is a very short description of the change.这是对于更改的简单概括。

● 以动词开头,使用第一人称现在时,例如,使用 “change” 而不是 “changed” 或 “changes” 。

● 首字母无需大写 。

● 结尾无需添加句号 (.) 。

消息 <主体>

● 像上面那样,以动词开头,使用第一人称现在时,例如,使用 “change” 而不是 “changed” 或 “changes” 。

● 需要包含修改动机、修改前后的对比。

消息<注脚>

不兼容变更

如果修改后与过去的版本不兼容,则<注脚>部分以 BREAKING CHANGE 开头,后面是对变动的描述、理由和迁移方法。

相关问题

因为本次提交而被关闭的问题( issues )需要被列出,例如:

Closes #234

或者:

Closes #123, #245, #992

文章除特别声明之外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处。