git 提交記錄回顧總結

說明

年前我須要寫公司的年度工做總結，因此把項目裏的提交日誌拉出來查看，其中有幾類提交是無效的也是沒有意義的，整理起來十分蛋疼，因此記錄下來。

示例

只有操做類型

• fix
• add

上面這兩個能夠知道是修復功能和添加功能，可是須要看代碼才能知道修復的是什麼，添加的是什麼。

提交說明使用外文進行說明

• fix refund

英文很差的人可能看到英文得須要想幾秒，甚至須要翻譯。

無詳細說明

• 嚴重BUG修復
• 退貨退款時間記錄

雖然知道是修復嚴重 BUG，可是 BUG 是什麼功能，爲何是嚴重 BUG 並不知道。而第二種雖然沒多大毛病，但改爲 「補充遺漏退貨退款完成時間」 會更好些。

多個功能混在一塊兒提交

1. 修改xxx
2. 添加xxx
3. 去除xxx

不建議這樣子提交，可是後面回顧代碼的時候區分不出每一個項對應的內容。不要怕提交條數多，若是須要審閱代碼就知道分開提交的好處了。

無心義的說明

• 修復 xxx 文件

提交記錄裏會記錄當次提交的全部文件，沒有說明的意義。

使用 GitHub issues 的方式提交

• fix issues #894

這種提交是模仿 GitHub 上的提交方式，它會自動關聯上指定的 issues，對直接在 GitHub 上審閱代碼時很好用。可是對於徹底獨立的代碼倉庫來講，會不知道具體的問題是什麼。能夠保留這個方式寫在說明第二行便可。gogs 也有相似的功能。但對於禪道，這種沒有關聯的來講，徹底沒有必要記錄上去。

總結

1. 對提交進行分類
2. 統一提交格式
3. 過段時間回來查看提交記錄還能看明白提交說明，那就表明說明表述上沒有問題

feat: xxx 功能
詳細說明：

fix: xxx 功能的 xxx 問題
詳細說明：
關聯issues：#123

del: xxx 功能[的 xxx 方法]
詳細說明：

adjust: xxx 功能[的 xxx]
詳細說明：

[] 爲可選項