1. 程式人生 > 其它 >Git提交規範

Git提交規範

Commit message 的格式

每次提交,Commit message 都包括三個部分:Header,Body 和 Footer。

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

其中,Header 是必需的,Body 和 Footer 可以省略。

不管是哪一個部分,任何一行都不得超過72個字元(或100個字元)。這是為了避免自動換行影響美觀。

Header

Header部分只有一行,包括三個欄位:type(必需)、scope(可選)和subject(必需)。

(1)type

  • feat:新功能(feature)

  • fix:修補bug

  • docs:文件(documentation)

  • style: 格式(不影響程式碼執行的變動)

  • refactor:重構(即不是新增功能,也不是修改bug的程式碼變動)

  • test:增加測試

  • chore:構建過程或輔助工具的變動

如果type為feat和fix,則該 commit 將肯定出現在 Change log 之中。其他情況(docs、chore、style、refactor、test)由你決定,要不要放入 Change log,建議是不要。

(2)scope

scope用於說明 commit 影響的範圍,比如資料層、控制層、檢視層等等,視專案不同而不同。

(3)subject

subject是 commit 目的的簡短描述,不超過50個字元。

  • 以動詞開頭,使用第一人稱現在時,比如change,而不是changed或changes

  • 第一個字母小寫

  • 結尾不加句號(.)

以上的Header是最重要的,哈哈哈哈哈哈