提交格式:
<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#
所有不兼容修改都必須在 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>