提交訊息產生器

提交詳情

0/72 字元

必須填寫摘要

解釋什麼和為什麼，而不是如何

即時預覽

填寫詳細資訊以產生提交訊息...

相關工具

模擬數據生成器生成模擬數據Markdown 編輯器與預覽器即時 Markdown 編輯器與預覽代碼差異檢查器並排比較代碼/文字

關於此工具

約定式提交規範是一個輕量級的提交訊息約定。它提供了一套簡單的規則來建立明確的提交歷史，使得在此基礎上編寫自動化工具變得更容易。

提交訊息格式

<type>(<scope>): <subject>

<body>

<footer>

優勢

  • 自動產生變更日誌（CHANGELOG）
  • 自動確定語義化版本號的升級
  • 向團隊成員和利益相關者傳達變更的性質
  • 觸發建置和發布流程
  • 讓人們更容易貢獻，透過讓他們探索更結構化的提交歷史

常見類型

✨
feat — A new feature
🐛
fix — A bug fix
📚
docs — Documentation only changes
💎
style — Code style changes (formatting, etc)
♻️
refactor — Code refactoring
✅
test — Adding or updating tests

頁尾用法

頁尾是可選的，包含關於提交的元資料。常見用例包括：

破壞性變更: 使用 BREAKING CHANGE: 表示不相容的 API 變更。這將觸發語義化版本控制中的主版本號升級。
BREAKING CHANGE: API 端點現在需要身份驗證
使用者必須更新其 API 客戶端以包含身份驗證令牌
問題引用: 使用 Closes、Fixes 或 Resolves 等關鍵字將提交連結到問題追蹤器。
Closes #123
Fixes #456, #789
共同作者和審查者: 在提交中標註貢獻者和審查者。
Co-authored-by: John Doe <john@example.com>
Reviewed-by: Jane Smith <jane@example.com>