開發輔助

Git 提交資訊產生器

免費線上 Git 提交資訊產生器,遵循約定式提交(Conventional Commits)格式。透過型別、作用域、描述、正文、破壞性變更和頁尾欄位建構結構化的提交資訊。

免費使用 無需註冊 在瀏覽器中執行

工具工作區

...

什麼是 Git 提交資訊產生器?

Git 提交資訊產生器幫助開發者按照約定式提交規範編寫結構良好的提交資訊。約定式提交提供了一種標準化格式——type(scope): description——使提交歷史更具可讀性,支援使用 semantic-release 等工具實現自動化版本管理,並簡化變更日誌的產生。本工具引導你逐步填寫提交資訊的各個部分,確保專案中的提交風格一致。

如何使用 Git 提交資訊產生器

  1. 1從下拉選單中選擇提交型別(feat、fix、docs、style、refactor、perf、test、build、ci、chore 或 revert)。
  2. 2可選輸入作用域,指明受影響的程式碼區域(如 auth、api、ui)。
  3. 3用祈使語氣撰寫簡潔的變更描述。
  4. 4可選新增更長的正文,提供關於變更的額外上下文資訊。
  5. 5如果提交引入了破壞性 API 變更,請開啟“破壞性變更”並描述具體影響。
  6. 6可選新增頁尾引用,如 'Closes #123' 或 'Refs #456'。
  7. 7開啟“包含表情字首”為提交型別新增視覺化 emoji。
  8. 8使用複製按鈕複製產生的提交資訊。

使用場景

語義化版本自動化

使用約定式提交讓 semantic-release 或 standard-version 等工具根據提交型別自動確定版本號變更(主版本、次版本、補丁版本)。

自動產生變更日誌

從提交歷史自動產生結構化的變更日誌,將新功能、缺陷修復和破壞性變更分類整理為有序的釋出說明。

團隊提交規範

在開發團隊中統一提交資訊格式,使程式碼審查和專案歷史記錄更易瀏覽和理解。

開源專案貢獻

在向要求使用約定式提交的開源專案貢獻程式碼時,遵循廣泛採用的提交約定以配合其 CI/CD 流水線。

常見問題

什麼是約定式提交格式?

約定式提交是一種編寫標準化提交資訊的規範。格式為:type(scope): description,後面可選跟正文和頁尾。'feat' 和 'fix' 等型別分別對應語義化版本的 MINOR 和 PATCH 升級,而 'BREAKING CHANGE' 頁尾或型別後的 '!' 會觸發 MAJOR 版本升級。

應該使用哪種提交型別?

'feat' 用於新功能, 'fix' 用於缺陷修復, 'docs' 用於文件變更, 'style' 用於格式調整, 'refactor' 用於程式碼重構, 'perf' 用於效能最佳化, 'test' 用於測試變更, 'build' 用於建構系統變更, 'ci' 用於 CI 配置變更, 'chore' 用於維護任務, 'revert' 用於回退提交。

作用域是必填的嗎?

不是,作用域是可選的。它提供了關於受影響程式碼區域的額外上下文資訊(如 'auth'、 'api'、 'ui')。有些團隊要求填寫作用域,有些則將其設為可選——請遵循你專案的約定。

冒號前的 '!' 是什麼意思?

放在型別/作用域之後、冒號之前的感嘆號 '!' 表示破壞性變更。例如 'feat(api)!: change auth endpoint' 表示此提交引入了破壞性 API 變更,等同於新增 'BREAKING CHANGE' 頁尾。

可以在提交資訊中使用表情符號嗎?

可以,許多團隊和開源專案使用表情符號作為提交型別的視覺化字首(如 ✨ 表示 feat,🐛 表示 fix)。雖然這不是約定式提交規範的正式組成部分,但表情符號可以提高提交日誌和 GitHub 介面的可讀性。在本工具中開啟表情選項即可新增。

資料會離開我的裝置嗎?

不會。此工具會直接在你的瀏覽器中處理輸入內容,不需要把資料上傳到我們的伺服器。若你要處理敏感資訊,仍建議在複製、下載或分享前先自行確認內容。