開發者 / Git
Conventional Commit 提交訊息小幫手(產生器與檢查工具)
建立符合 Conventional Commits 1.0.0 格式的提交訊息:選擇類型、加入範圍和描述、標示重大變更、加入內文與頁尾,並查看 semantic-release 等工具會產生的版本更新。
Conventional Commit 提交訊息小幫手(產生器與檢查工具): 此工具會將第一行寫成 type(scope): description;如果是重大變更,則會在 scope 後加上 !,接著在空白行後加入內文與頁尾,並包含附有移轉說明的 BREAKING CHANGE:。工具會提醒第一行超過72個字元、結尾有句號或第一個字母為大寫的情況,並顯示這次提交會觸發 major、minor 或 patch 版本更新。 全程在瀏覽器中於本機執行,檔案不會上傳至伺服器。
- 分類
- 開發者工具
- 使用次數
- 在瀏覽器中
- 費用
- 免費・免註冊
- 可用狀態
- 可立即使用
全程在瀏覽器中執行
提交訊息
feat(auth): add login with passkeys
第一行有35個字元·發布版本:minor(新功能)
Conventional Commits 1.0.0:type(scope):描述,空白行後可加入選填的內文,以及BREAKING CHANGE:等頁尾。type後的!表示重大變更。semantic-release和release-please等工具會讀取這些訊息,以決定下一個版本號碼並撰寫變更記錄。
範例
feat(auth)!:加入使用通行金鑰登入、空白行、說明原因的內文,以及BREAKING CHANGE:工作階段現在會在24小時後過期。由於有!,發布工具會將這視為主要版本。
版本
Conventional Commits會對應到語意化版本控制:fix對應修補版本、feat對應次要版本,而重大變更對應主要版本。使用semver計算機算出下一個版本號。
使用方式
- 選擇類型,例如 feat 或 fix,並加入選填的範圍。
- 撰寫簡短描述;如果有重大變更,請加以標示。
- 視需要加入內文或頁尾,然後複製訊息。
隱私與限制
所有操作都在您的瀏覽器中執行。
相關工具
常見問題
feat 和 fix 有什麼不同?
feat 代表新增使用者可以使用的功能,會產生 minor 版本更新;fix 代表修正錯誤,會產生 patch 版本更新。
什麼時候算是重大變更?
當現有使用者必須變更某些內容才能繼續使用時,例如移除選項、重新命名函式,或變更預設值。
我一定要使用 Conventional Commits 嗎?
不一定,但 semantic-release、release-please 和 commitlint 等工具會依賴它來自動管理版本號和變更記錄。
免費工具・使用在瀏覽器中次・免註冊