Conventional Commits 筆記
tags: commit, git@holla
筆記：學會 Conventional Commits，讓 Git 提交訊息變整齊
最近翻 Git 紀錄，發現自己以前的提交訊息亂七八糟，像是「改了點東西」這種，真的看不懂自己在幹嘛。😅 在朋友提醒下看到 Conventional Commits 這招，超簡單，能讓訊息變整齊，還能跟工具串起來。來記下重點，免得忘！
這是啥？
就是一套約好的提交訊息格式，長這樣：
<類型>[可選範圍]: <描述>
[可選正文]
[可選腳註]
- 類型：這次提交是幹啥，比如
feat（加新東西）、fix（修 Bug）。 - 範圍：改了哪塊，比如
api、ui（可以不寫）。 - 描述：一句話說清楚做了啥。
- 正文：想多記點細節就放這。
- 腳註：記大事，比如關 Issue。
試個兩個範例：
feat(api): add user signup endpoint
Added POST /signup API and updated docs.
Closes #15
包含用以提示重大變更的 ! 的提交說明
feat!: send an email to the customer when a product is shipped
常用的類型
feat：新功能fix：修 Bugdocs：改文件style：改程式碼的風格，不影響邏輯refactor：重構程式碼test：加測試chore：雜項（像更新套件）
為啥想用？
- 訊息整齊，看起來舒服，翻紀錄不頭痛。
- 能跟工具串連，自動弄變更日誌，省時間。
- 馬上知道每次提交在搞啥，不用猜。
怎麼搞？
- 去 官方網站 瞄一下，簡單到不行。
- 試試工具：
- Commitizen：幫忙一步步寫訊息。
- Semantic Release：自動整理更新紀錄。
- 跟團隊聊聊，乾脆大家都用這套。
提醒自己
- 描述短點，50 字內最好。
- 國際專案用英文，比較統一。
- 大改動記得加
!或寫BREAKING CHANGE，像上面範例這樣
感想
這招真的不難，感覺像幫 Git 提交訊息整理房間，以後紀錄乾淨又清楚。個人專案先試試，之後推給團隊，應該能讓大家少翻點白眼。😂 繼續練起來！
參考:
閱讀人數: ...