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

1

2

3

4

2、配置模板

mi@ubuntu:~$ vim ~/.gitmessage

#title [where/what] #JIRA-ID #brief description for this bug [what/why] #Change-Id:auto-generate

1

2

3

4

5

6

7

3、提交使用模板

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

4、查看提交記錄

mi@ubuntu:~$ git log --no-merges

參考鏈接

分布式Git - 向一個項目貢獻

編碼規范之Git commit message style

Git commit message 基本規范

Git

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。