工程开发
chinese-commit-conventions avatar

chinese-commit-conventions

适配国内团队的中文 Git 提交规范,基于 Conventional Commits 协议,集成 commitlint、husky 与自动生成 Changelog 工作流。

简介

本技能旨在为国内开发团队提供一套标准化、可自动化的 Git 提交规范与工作流。通过将国际通用的 Conventional Commits 协议与中文团队的沟通习惯相结合,本方案确保了 Git 提交历史的可读性、一致性与可维护性。它不仅仅是一套书写规范,更是一套集成了工具链的自动化管理方案,极大地提升了版本发布与代码审查的效率。

  • 完整实现了 Conventional Commits 1.0.0 规范的中文适配,明确定义了 feat, fix, docs, refactor, perf 等 10 种提交类型及其适用场景。

  • 提供结构化的提交消息模板,强制要求包含 scope(影响范围)、subject(简短描述)与 body(详细背景及方案),确保每次变更都有迹可循。

  • 集成了现代前端工程化工具链,包括 commitlint 规则配置、husky 钩子配置以及 lint-staged 自动化格式校验,从源头确保提交质量。

  • 支持自动生成 CHANGELOG.md,并针对国内开发生态(如 Gitee, Coding, 极狐 GitLab 等)优化了 Issue 关联与版本迭代记录的生成逻辑。

  • 开发建议包括:保持 Subject 行在 50 字符以内且不加句号,Body 部分详述变更原因、技术方案摘要及影响范围,并强制要求通过 BREAKING CHANGE 标注不兼容的变动。

  • 工具内置了 .versionrc.js 与 commitlint.config.js 配置示例,方便团队通过 npx 或 npm 脚本快速落地到现有项目中。

  • 约束条件强调原子化提交,即每次提交只做一件事,并要求提交信息避免使用无意义的词汇(如“修改了代码”)。

  • 本技能特别适用于中大型研发团队,能够有效减少因提交信息混乱导致的排查难度,并助力实现自动化流水线发布。

仓库统计

Star 数
1,870
Fork 数
203
Open Issue 数
1
主要语言
Shell
默认分支
main
同步状态
空闲
最近同步时间
2026年5月3日 05:46
在 GitHub 查看
chinese-commit-conventions | Skills Hub