1. 程式人生 > 其它 >Git提交的正確姿勢:Commit message

Git提交的正確姿勢:Commit message

關於git的提交

原文:Commit message 和 Change log 編寫指南

Git提交的正確姿勢:Commit message

Git 每次提交程式碼,都要寫 Commit message(提交說明),否則就不允許提交。

$ git commit -m "hello world"

上面程式碼的-m引數,就是用來指定 commit mesage 的。

如果一行不夠,可以只執行git commit,就會跳出文字編譯器,讓你寫多行。

$ git commit

一般來說,commit message 應該清晰明瞭,說明本次提交的目的。

一、Commit message 的作用

格式化的Commit message,有幾個好處。

(1)提供更多的歷史資訊,方便快速瀏覽。

比如,下面的命令顯示上次釋出後的變動,每個commit佔據一行。你只看行首,就知道某次 commit 的目的。

$ git log <last tag> HEAD --pretty=format:%s

2)可以過濾某些commit(比如文件改動),便於快速查詢資訊。

比如,下面的命令僅僅顯示本次釋出新增加的功能。

$ git log <last release> HEAD --grep feature

(3)可以直接從commit生成Change log。

Change Log 是釋出新版本時,用來說明與上一個版本差異的文件。

二、Commit message 的格式

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

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

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

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

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
  • 第一個字母小寫
  • 結尾不加句號(.)

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

有兩個注意點。

(1)使用第一人稱現在時,比如使用change而不是changed或changes。

(2)應該說明程式碼變動的動機,以及與以前行為的對比。

Footer 部分只用於兩種情況。

(1)不相容變動

如果當前程式碼與上一個版本不相容,則 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.

2)關閉 Issue

如果當前 commit 針對某個issue,那麼可以在 Footer 部分關閉這個 issue 。

Closes #234
12

也可以一次關閉多個 issue 。

Closes #123, #245, #992
12

Revert

還有一種特殊情況,如果當前 commit 用於撤銷以前的 commit,則必須以revert:開頭,後面跟著被撤銷 Commit 的 Header。

revert: feat(pencil): add 'graphiteWidth' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
1234

Body部分的格式是固定的,必須寫成This reverts commit .,其中的hash是被撤銷 commit 的 SHA 識別符號。

如果當前 commit 與被撤銷的 commit,在同一個釋出(release)裡面,那麼它們都不會出現在 Change log 裡面。如果兩者在不同的釋出,那麼當前 commit,會出現在 Change log 的Reverts小標題下面。