提交信息生成

Conventional Commits 格式提交信息生成器,選擇類型/scope/描述

0/72

填寫描述後預覽提交資訊

Conventional Commits 格式

<type>[scope]: <description>

[optional body]

[optional footer(s)]

常見示例

關於 提交信息生成 的詳細介紹

所屬分類: 開發規範 純瀏覽器本地運算

提交訊息生成器是一款嚴格遵循 Conventional Commits(約定式提交)國際規範的 Git 提交訊息視覺化輔助工具。引導開發者條理分明地填寫提交類型(Type)、影響範疇(Scope)、主旨摘要(Subject)、詳細內文(Body)與頁尾宣告(Footer)。

支援快速標註破壞性變更(BREAKING CHANGE)以及關聯關閉之 Issue 編號(如 Closes #456),自動組合為標準規範之 Commit Message,大幅增強 Git 歷史紀錄之可讀性,並完美契合自動化版本發布(semantic-release)與 Changelog 自動擷取工具。

#git #commit #conventional #message #changelog

核心功能與特色

  • 完整涵蓋約定式提交所有核心類型(包含 feat、fix、docs、refactor、perf 等)
  • 支援選填模組範疇(Scope)與規範的主旨文字輸入校驗
  • 提供破壞性更新(BREAKING CHANGE)一鍵宣告,自動附加驚嘆號(!)語法
  • 支援 Issue 關聯連結(如 Closes #Issue),一鍵複製完整 `git commit -m` 指令

使用步驟

  1. 1

    挑選本次程式碼異動的類型類別(如新增功能挑選 feat,修復 Bug 挑選 fix)。

  2. 2

    填寫模組名稱(Scope)與簡要描述,按需補充詳細變更原因。

  3. 3

    檢視生成之標準提交訊息,點選複製按鈕即可貼入終端機執行提交。

常見應用場景

  • → 引導團隊初學者或新進同仁迅速掌握業界主流的 Conventional Commits 規範
  • → 為需要自動化提取發行紀錄(CHANGELOG)的專案建立乾淨標準的 Git 歷程
  • → 標註涉及資料結構變更或相容性中斷的重大更新,避免發布遺漏

同類推薦工具

常見問題與隱私說明

什麼時候該在類型後加上驚嘆號(例如 feat!: ...)?

當該筆變更包含了會破壞既有對外相容性(Breaking Change)的重大修改時,加上驚嘆號可明確警示下游使用者需要重大版本升級。

chore 與 refactor 兩種類型該如何區分?

`refactor` 指的是既不修復 Bug 也不新增功能的程式碼重構(如提取共用函式);而 `chore` 通常指調整輔助工具、建置流程或更新相依套件。