書寫良好的 Git 提交資訊
在使用 Git 的過程中,可以發現 Git 是會強制每次提交都要寫提交訊息(commit message)的,這也算是 Linus 的良好程式設計習慣的體現。準確恰當的提交資訊對於回溯專案開發歷程、尋找特定功能的程式碼片段等等,都很有幫助。
真正到了要寫提交資訊的時候,很多人可能會圖省事,使用...
,或者abc
這養的內容矇混過去。這可不是什麼好習慣。Git 的提交資訊應該簡明扼要,描述當前提交所做的主要的事情。可以使用一些可以描述所做改動的關鍵詞作為字首然後書寫詳細的資訊。
關鍵詞有兩類,一類是動詞,表示進行的動作;另一類是名詞,可以與業務相關,也可以是動詞的名詞化形式。下面是一些常見的關鍵詞:
-
add
,或feature
,表示新增新功能 -
fix
,缺陷修復 -
hotfix
,緊急的缺陷修復 -
update
,對已有功能進行更改或優化 -
remove
,或者rm
、delete
,刪除部分程式碼、功能 -
refactor
,重構了一些程式碼、功能 -
workflow
,工作流程更改 -
chore
,瑣碎的修改
# 新增了支援使用者上傳檔案的功能 $ git commit -m 'add: 上傳檔案功能' # 修復了一個線上問題 $ git commit -m 'fix: **頁面數字取值問題' # 對某些程式碼進行了重構 $ git commit -m 'refactor: 重構商品列表頁'
此外,對於每個專案,可以用業務相關的名詞作為關鍵詞字首。例如:
# docs 表示這是對文件進行的修改 $ git commit -m 'docs: 更新介面文件'