Git Commit Message 程式碼提交規範
5,282 0
上個月公司來了一位前端大神，為我們團隊制定了一些技術方面的規範，其中有一項是關於在 Git 上提交程式碼時撰寫 Commit Message 的一些規範。開始我還覺得多此一舉，看了許多大型專案的 Commit 紀錄之後，才知道這個規範算是業界的標準。
先來看看我的 CodeStudy 專案裡寫的是什麼 Commit Message：
再看看尤雨溪大神的作品 Vue 框架的 Commit Message：
果然一個規範的 Commit Message 真的能讓人眼前一亮，可以快速了解到該 Commit 的內容和涉及的功能模組。下面說說規範化 Commit Message 能帶來什麼好處。
規範化的好處
- 便於程式設計師追溯提交歷史，了解發生了什麼情況。
- 一旦約束了
Commit Message，意味著我們將慎重地進行每一次提交，不能再一股腦地把各種各樣的改動都放在一個git commit裡面，這樣一來整個程式碼改動的歷史也將更加清晰。 - 格式化的
Commit Message才可以用於自動化輸出Change log。
Git 提交規範
<type>(<scope>): <subject>
<body>
<footer>
| 名稱 | 作用 |
|---|---|
| type | 用於說明 Git Commit 的類別，只允許使用下表的標識 |
| scope | 用於說明 Commit 影響的範圍，比如資料層、控制層、視圖層等 |
| subject | Commit 目的的簡短描述，一般不超過 50 個字元 |
| body | 可忽略，可多行，詳細的描述，與 header 之間空一行 |
| footer | 可忽略，一般用於不相容更新或關閉 issue，與 body 之間空一行 |
| 類型 | 描述 |
|---|---|
| sync | 同步主線或分支的 bug |
| merge | 程式碼合併 |
| revert | 回滾到上一個版本 |
| chore | 建置過程或輔助工具的變動 |
| test | 增加軟體測試 |
| perf | 優化相關，比如提升效能、體驗 |
| refactor | 重構，既不是新增功能，也不是修改 bug 的程式碼變動 |
| style | 格式，不影響程式碼執行的變動 |
| docs | 文件撰寫或更新 |
| fix / to | 修復 bug，可以是 QA 發現的 bug，也可以是研發自己發現的 bug |
| feat | 新功能（feature） |
外掛推薦
在 VS Code 上面強烈推薦 Commit Message Editor 外掛，可以快速產生 Git Commit Message。
評論
(0)暫無評論，來說兩句吧