commit

commit

熱門

用於每次提交變更或草擬提交訊息的請求。建立 Sentry 風格的常規提交,並附帶問題參考。

881星標
45分支
更新於 2026/7/21
SKILL.md
唯讀
名稱
commit
描述

用於每次提交變更或草擬提交訊息的請求。建立 Sentry 風格的常規提交,並附帶問題參考。

Sentry 提交訊息

提交前

git branch --show-current

如果分支是 mainmaster,除非使用者明確要求直接提交,否則請建立一個功能分支。重新檢查分支,如果仍然是 mainmaster,則停止。

一次提交一個連貫、可獨立審查的變更。

訊息規則

使用:

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

<optional body>

<optional footer>
  • Scope 為選填。若為破壞性變更,請在 : 前加上 !
  • 使用祈使句、現在式撰寫 subject;首字大寫,省略結尾句點,並控制在 70 個字元以內。
  • 每行保持在 100 個字元以內。
  • 僅在必要時使用 body。說明變更內容與原因,必要時包含先前行為或動機。
  • 切勿包含客戶或組織名稱、使用者電子郵件、支援單內容、機密或個人識別資訊。請改為描述技術症狀。

允許的類型:featfixrefperfdocstestbuild
cichorestylemetalicenserevert

使用 ref 表示不改變行為的重構,style 表示不改變邏輯的格式調整,meta 表示儲存庫元資料。

頁尾

  • Fixes <issue> 在合併時關閉問題。
  • Refs <issue> 連結問題但不關閉。
  • 對於破壞性變更,請加上 BREAKING CHANGE: <impact>

建立提交

對段落和頁尾使用獨立的 -m 參數。切勿在提交訊息中使用 literal \n 序列或開啟互動式編輯器。

git commit -m "fix(api): Handle null response in user endpoint" \
  -m "Return 404 when the user API finds a deleted account." \
  -m "Fixes SENTRY-5678"