工程開發
chinese-commit-conventions avatar

chinese-commit-conventions

為中文開發團隊打造的 Git 提交規範,包含 Conventional Commits 轉譯與自動化 Changelog 工具鏈。

簡介

本技能為中文開發團隊提供了一套系統化的 Git 提交規範與自動化工作流。它不僅遵循國際通用的 Conventional Commits 規範,更針對中文團隊的溝通慣例進行了深度適配,確保 Git 日誌具備高度的可讀性與自動化價值。此工具組合能有效協助團隊在代碼審查與版本迭代過程中,快速理解變更意圖。

  • 基於 Conventional Commits 1.0.0 標準,提供完整的提交類型 (type) 與適用場景指南,明確區分 feat、fix、refactor 等邏輯差異。

  • 制定了結構化的提交模板,包含 scope、subject、body 與 footer,並針對中文字元的排版特性優化了行長限制與描述規則。

  • 整合了完整的工程化工具鏈,包括用於自動生成 CHANGELOG.md 的 conventional-changelog、強制提交格式的 commitlint,以及確保 commit 質量的 husky 鉤子。

  • 支援跨平台 Issue 關聯(包含 GitHub、Gitee、Coding 等主流平台),並提供清晰的 Breaking Change 標註指南以應對重大變更。

  • 最佳實踐建議提交標題應控制在 50 個字元內,且必須使用動賓短語明確描述變更內容,避免使用模糊不清的「修復代碼」等描述。

  • 規範內容說明了如何透過 Body 部分撰寫變更背景、技術方案與影響範圍,確保開發者能提供足夠的上下文給後續的維護者。

  • 針對 CI/CD 環境(如 GitHub Actions, Gitee Go, Coding CI)提供了具體的配置範例,協助團隊實現自動化發佈流程。

  • 本技能特別適合希望導入技術債管理、提升團隊協作效率及簡化發佈文檔生成的技術團隊與架構師使用。

倉庫統計

Star 數
1,870
Fork 數
203
Open Issue 數
1
主要語言
Shell
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 上午05:46
在 GitHub 查看