Git 提交訊息樣式建議 « 關於網路那些事...
阿新 • • 發佈:2018-12-10
Git 官方建議的提交訊息樣式,可以讓提交訊息更加容易理解及管理
原則上,可以將訊息分成三種型態
- 型別:標題
- 內容
- 註解
類別
首先,在 commit 標題之前,建議要先清楚定義類別,定義方式有以下建議:
feature or feat: 新功能 fix:修復錯誤 docs:文件新增, 修改相關 style:格式修正(程式碼無變動) refactor:原有程式碼重構 test:測試,測試重構(無變動到生產程式碼) chore:任務相關,更新任務,程式包配置變動等(無變動到生產程式碼)
標題
標題建議在 50 字元之內,第一個字母大寫,並且最後不必加句號。 標題,使用直接表達命令、需求、禁止、勸告..的方式,少用或許,可能,或間接的方式表達
內容
正文內容只需要解釋目前提交的任務,原因即可,而不必說明方法。
寫內容時,要在標題和內容之間保留一行空白,並且每一行的內容控制在 72 字元內。
註解
註解可以用來描述問題的關鍵字,例如 使用者ID,問題特徵或注意事項等等。
解釋該提交資訊所解決的問題,說明你進行該變動的原因,而不是方法(程式碼本身可以解釋方法)。 該變動是否存在副作用或其他直覺性後果?在這裡進行解釋。
每一個段落都以一行空白做區隔
如果有使用問題追蹤,可以在最後加上引用,例如: 解決問題:#123 詳見:#456, #789
如果你喜歡我們的文章內容,請在這裡按個讚