__Notes
Git Commit Message 規範
這篇介紹了 Git Commit Message 的格式規範,包括標題、正文和尾注的結構,並提供了常見的提交類型和示例,幫助開發者撰寫清晰且有意義的提交消息
基本格式
<type>(<scope>): <subject>
<body>
<footer>
格式說明
commit message 由三個主要部分組成:
- 標題(header)
- 正文(body)
- 尾注(footer)
標題組成
標題包含三個部分:
- 類型(type)- 必填
- 範圍(scope)- 可選
- 主題(subject)- 必填
Type 類型對照表
類型 | 說明 |
---|---|
feat | 新功能 |
fix | 修復 bug |
docs | 文檔變更 |
style | 格式(不影響代碼運行的變動) |
refactor | 重構(既不是新增功能,也不是修復 bug) |
test | 增加測試 |
chore | 構建過程或輔助工具的變動 |
perf | 性能優化、改善功能 |
build | 建構程序或外部依賴的變動 |
ci | 持續集成相關的變動 |
revert | 撤銷先前的提交 |
merge | 合併分支 |
範例
feat(search): add fuzzy search to the search bar
This commit adds a fuzzy search algorithm to the search bar,
which allows users to search for terms that are similar to the ones they type in.
Closes #1234
撰寫原則
標題
- type: 必須是上述其中一個類型
- scope: 可選,用於說明 commit 影響的範圍
- subject: 簡短描述,清楚表達這次改動做了什麼
正文
- 可選
- 用於解釋這次改動的詳細原因和影響
- 若需換行,請空一行後再寫
尾注
- 可選
- 通常用於關聯 issue 編號
- 可以註明關閉的 issue:
Closes #123
或Fixes #123