git message規範

在正式參與項目開發之前，了解并且堅持使用一些規範更友善我們與同僚之間的合作。這些通常是約定俗成的。

git送出準則

git源碼中的Documentation/SubmittingPatches列舉了git送出規範相關的說明文檔。

送出之前的注意事項

1、檢查空白錯誤

git diff --check #确認将送出的内容中有無空白資訊

2、嘗試讓每一個送出成為一個邏輯上的獨立變更集

盡量使每一筆送出都成為獨立的patch，這讓同僚審查你的改動時盡量讓事情容易些。

3、重寫送出曆史

正式送出之前，可以通過修改本地送出曆史讓送出後的資訊更加易懂。

4、規範化送出資訊

這裡有份Tim Pope 寫的模闆，看看怎樣才是規範的送出描述。稍後我們手動建立一個git message送出模闆。

建立git message模闆

1、git config

mi@ubuntu:~$ git config --global -e

....
#添加
[commit]
        template = /home/mi/.gitmessage
      

2、配置模闆

mi@ubuntu:~$ vim ~/.gitmessage

#title [where/what]

#JIRA-ID 

#brief description for this bug [what/why]

#Change-Id:auto-generate
      

3、送出使用模闆

mi@ubuntu:~$ git commit -s #盡量不用 git commit -m "xx"

• 分布式Git - 向一個項目貢獻
• 編碼規範之Git commit message style
• Git commit message 基本規範