工程開發
commit-msg avatar

commit-msg

根據暫存的變更,依照 Chris Beams 的七大原則生成專業且符合規範的 Git 提交訊息。

簡介

commit-msg 技能是一款專為開發人員設計的核心工具,旨在透過自動產生高品質的 Git 提交訊息來簡化版本控制流程。它會分析本機儲存庫中已暫存的變更,並根據 Chris Beams 的七大原則生成提交訊息,確保專案記錄的易讀性與一致性。此工具適用於重視維護性並希望減少手動編寫描述性訊息負擔的軟體工程師與開發團隊。

  • 自動分析已暫存變更的差異 (diff),以辨識關鍵修改。

  • 產生限制在 50 個字元以內的標題列,確保使用祈使語氣與正確的大小寫。

  • 構建結構化的本文段落,專注於解釋「做了什麼」與「為何而做」而非「如何執行」,並限制每行 72 個字元。

  • 支援多行提交訊息,確保標題與詳細說明之間的清晰區隔。

  • 無縫整合現有的 Git 工作流程 (git add),提供即時的訊息生成回饋。

  • 在呼叫此技能前,請確保所有變更皆已使用 'git add' 進行暫存。

  • 此工具專注於已暫存檔案的最終狀態,忽略中間過程產生的雜訊。

  • 使用如 'create commit message' 或 '커밋 메시지 만들어줘' 等觸發語句啟動流程。

  • 產出的訊息為建議範本,建議使用者在最終確認提交前進行審閱。

  • 確保使用者所在的目錄正確,agent 會直接於本機情境中執行分析。

  • 非常適合用於標準化儲存庫日誌、關聯問題追蹤系統 (例如:Fixes #1234),並提升在 Git、GitHub 或 GitLab 環境下的 Pull Request 歷史品質。

倉庫統計

Star 數
1
Fork 數
0
Open Issue 數
0
主要語言
Python
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 下午08:12
在 GitHub 查看