看了不少開源項目,發現目前Angular的這個規範比較和我胃口,所以轉載過來,用於記錄,並且我會執行一段時間,看看這種規範下的commit message是否如其他人宣傳的那樣好。
每次提交,Commit message 都包括三個部分:header,body 和 footer。
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
其中,header 是必需的,body 和 footer 可以省略。
不管是哪一個部分,任何一行都不得超過72個字符(或100個字符)。這是爲了避免自動換行影響美觀。
Header
Header部分只有一行,包括三個字段:type(必需)、scope(可選)和subject(必需)。
type
用於說明 commit 的類別,只允許使用下面7個標識。
feat:新功能(feature)
fix:修補bug
docs:文檔(documentation)
style: 格式(不影響代碼運行的變動)
refactor:重構(即不是新增功能,也不是修改bug的代碼變動)
test:增加測試
chore:構建過程或輔助工具的變動
如果type爲feat和fix,則該 commit 將肯定出現在 Change log 之中。其他情況(docs、chore、style、refactor、test)由你決定,要不要放入 Change log,建議是不要。
scope
scope用於說明 commit 影響的範圍,比如數據層、控制層、視圖層等等,視項目不同而不同。
例如在Angular,可以是$location, $browser, $compile, $rootScope, ngHref, ngClick, ngView等。
如果你的修改影響了不止一個scope,你可以使用*代替。
subject
subject是 commit 目的的簡短描述,不超過50個字符。
其他注意事項:
以動詞開頭,使用第一人稱現在時,比如change,而不是changed或changes
第一個字母小寫
結尾不加句號(.)
Body
Body 部分是對本次 commit 的詳細描述,可以分成多行。下面是一個範例。
More detailed explanatory text, if necessary. Wrap it to
about 72 characters or so.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Use a hanging indent
有兩個注意點:
使用第一人稱現在時,比如使用change而不是changed或changes。
永遠別忘了第2行是空行
應該說明代碼變動的動機,以及與以前行爲的對比。
Footer
Footer 部分只用於以下兩種情況:
不兼容變動
如果當前代碼與上一個版本不兼容,則 Footer 部分以BREAKING CHANGE開頭,後面是對變動的描述、以及變動理由和遷移方法。
BREAKING CHANGE: isolate scope bindings definition has changed.
To migrate the code follow the example below:
Before:
scope: {
myAttr: 'attribute',
}
After:
scope: {
myAttr: '@',
}
The removed `inject` wasn't generaly useful for directives so there should be no code using it.