★ FEATURED ARTICLE 见过太多这样的场景代码写得漂漂亮亮到了git commit这一步随手甩一句fix bug或update就交差了。等三个月后真要回查某次改动git log里全是fix xxx、update、temp这种信息想定位一个具体功能变更简直像在垃圾堆里翻钥匙。Commitizen 就是为解决这个问题而生的。它通过交互式问答引导你写结构化的提交信息把feat(api): add user login endpoint这种一眼能看懂的提交从口号变成默认动作。只要团队里有人开始用其他人看到生成的提交信息自然也会跟着规范化。这篇文章就围绕 Commitizen 的交互式提交流程讲清楚它背后的设计逻辑、完整配置方法、实操细节以及我在真实项目里踩过的坑和落地经验。1. 为什么需要 Commitizen提交信息混乱的根源1.1 手动提交的真实痛点如果你在一个超过三个人的团队里待过大概率见过下面这些提交信息fix bug update modify something aaa这些信息不是不能用但问题在于它造成了严重的信息损耗。git log、git blame、Code Review 时的提交上下文、甚至 release notes 的自动生成全部依赖提交信息的质量。一条fix bug你完全看不出它修了什么模块的什么问题看不出是不是包含破坏性变更也看不出它对应哪个需求单或 issue。当线上出问题需要排查改动来源时你只能在git log里一条条点开 diff效率极低。我还见过一种更隐蔽的混乱提交信息写得很长但没有任何结构。比如把修改了登录模块的token逻辑顺便优化了首页布局还更新了文档全塞在一行里。这种信息在写的时候感觉省事但在 review 和回溯的时候极其痛苦。提交信息本质上是异步沟通工具它在你写完代码几个月后还要继续被人读。写得越随意欠下的技术债越多。1.2 约定式提交规范Conventional Commits是什么为了解决这种混乱Angular 团队在推行 AngularJS 开发流程时提出了一套提交信息规范后来发展成社区广泛使用的 Conventional Commits 规范。它的核心格式非常简单type(scope): subject BLANK LINE body BLANK LINE footer其中type表示提交类型比如feat表示新功能、fix表示修复scope表示影响范围比如模块名、组件名subject是标题要求用祈使句尽量精简body是详细描述footer用来放破坏性变更说明和关联的 issue。这个规范最有价值的地方是它把提交信息分成了机器可读和人可读两个层面。机器层面通过feat、fix等类型CI/CD 工具可以自动判定版本号应该升 minor 还是 patch甚至自动生成 changelog。人可读层面扫一眼feat(auth): add refresh token rotation你就知道这次改动做了什么影响哪个模块和令牌刷新有关信息密度极高。1.3 Commitizen 的定位把规范从靠自觉变成走流程规范本身不复杂难的是长期稳定执行。靠文档、靠 Code Review 时口头提醒基本都会被大家当作没看见。Commitizen 的突破点在于它把写提交信息这件事从空白的命令行输入框转变为一步步交互式问答的表单。你不需要背规范、不需要记类型、不需要考虑格式。Commitizen 会像面试官一样问你一个个问题这次变更的类型是什么影响范围是哪个模块标题写什么有没有破坏性变更关联哪个 issue你只管回答最终符合规范的提交信息由它生成。这也是 Commitizen 被设计成一个交互式 CLI 而不是一个校验工具的原因——它不是在你犯错后惩罚你而是在你动手之前就通过流程帮你避开了犯错的可能。2. 核心原理与工具链拆解2.1 CLI Adapter 架构一次解耦处处复用要理解 Commitizen 的交互式提交流程先得明白它的架构。Commitizen 本身是一个命令行工具cz-cli但实际上它只负责交互主流程具体的提问内容、可选类型、字段规则是由一个独立的适配器adapter来定义的。这个设计非常像开发中常见的策略模式。cz-cli是骨架Adapter 是血肉。GitHub 上常见的 adapter 有Adapter特点cz-conventional-changelog官方默认完全遵循 Conventional Commits 规范cz-customizable允许自定义提问文案、类型列表、字段规则cz-emoji在提交信息中加入 emoji 标识适合个人项目cz-jira-smart-commit适配受 Jira Smart Commit 约束的团队这种解耦带来的直接好处是团队可以复用同一套交互流程但用不同 adapter 来调整具体规则。比如你所在团队有成体系的内部规范不想被 Conventional Commits 绑死就可以用cz-customizable自定义字段提示同时仍然保留交互式引导的体验。我在实际项目中就见过一个团队把 type 列表定制成业务名比如module-projectA、module-projectB这种因为他们的发布流程根本不需要区分feat和perf只用关心模块归属。2.2 适配器字段与提交格式的映射以最常见的cz-conventional-changelog为例它会在交互流程中依次问这些问题Select the type of change that youre committing选择提交类型What is the scope of this change?影响范围Write a short, imperative tense description of the change简短标题Provide a longer description of the change详细描述可跳过Are there any breaking changes?是否存在破坏性变更Does this change affect any open issues?是否关联 issue这些问题看似简单实际上每一个都精确对应了 Conventional Commits 格式中的某个部分。用一句话总结适配器问什么生成出来的git commit信息就包含什么。type对应第一个斜杠前的单词scope对应斜杠后的括号subject对应冒号后的标题body和footer分别在空行后拼接。所以当你看到一个 Commitizen 生成的提交信息feat(api): add user login endpoint Add a new endpoint that allows users to login with email and password. Closes #42你应该能反向推断出用户刚才做了哪些交互选择第一题选了feat第二题填了api第三题填了add user login endpoint第四题填写了以Add a new endpoint开头的那段描述第六题选择了是并填入了#42。2.3 为什么要限制 subject 不超过 87 字符有个经常被忽略但很值得解释的细节cz-conventional-changelog在询问标题时会给一个长度限制默认是 87 个字符。这不是随便定的数字。Git 底层在存储提交对象时提交信息的头部如果过长默认的git log格式化显示会被截断更重要的是很多工具比如 GitHub、GitLab 的提交列表在渲染时会固定显示第一行太长的标题会被打省略号导致信息不完整。87 这个数字也不是 cz-conventional-changelog 拍脑袋定的。在大多数终端宽度为 80 字符的场景下加上type(scope):的前缀以后剩余可写空间大概就是 87 字符左右。这意味着标题一行终端一屏无论用什么工具看提交信息都不会出现被迫横向滚动或被动截断的情况。所以在实操中我会特别注意subject 要短具体细节放到 body 部分而不是硬塞进标题。3. 环境准备与安装步骤3.1 全局安装还是项目局部安装Commitizen 推荐作为项目的开发依赖安装而不是全局安装。原因很现实如果开发者全局装了 Commitizen换了电脑、换了 CI 机器就没了而把它写进package.json的devDependencies任何 clone 项目的人执行npm install后都会自动拥有完整的提交工具链。对一个团队项目来说这种开箱即用的体验价值远大于全局安装的方便。不过全局安装也不完全是禁区。如果你是个人维护多个项目、又懒得一个个配置npm install -g commitizen后直接在任何仓库里执行git cz也很顺畅。我个人的习惯是两者都装全局装一套用于快速体验项目里再局部装一套用于正式团队协作。项目里装的版本可以通过package.json锁得比较精确全局版本则保持较新互不影响。3.2 初始化适配器与 package.json 配置推荐在一个 Node.js 项目根目录下执行npx commitizen init cz-conventional-changelog --save-dev --save-exact这条命令做了三件事安装cz-conventional-changelog到项目的 devDependencies、在 package.json 中写入适配器路径配置、打印下一步使用提示。--save-exact参数表示锁定精确版本号避免以后适配器升级导致交互流程突然变化这一点在团队项目中尤其重要。执行完毕后检查 package.json你会看到多出来类似下面的内容{ scripts: { commit: cz }, config: { commitizen: { path: ./node_modules/cz-conventional-changelog } }, devDependencies: { commitizen: ^4.3.1, cz-conventional-changelog: ^3.3.0 } }需要特别说明的一点config.commitizen.path字段指定了默认使用的适配器位置。当项目里有多个适配器时这个字段决定了git cz启动后走哪套交互逻辑。我遇到过不少项目配置出错的情况根因基本都在这个 path 指向了不存在的包名或者 monorepo 子包中依赖没有提升到根目录导致路径失效。3.3 用 Husky 和 Commitlint 补上强制约束Commitizen 只负责帮你生成规范的提交信息它不保证团队成员一定会用它。有人就是喜欢我行我素地git commit -m hack你再怎么引导也拦不住。这时候就需要另一层兜底commit-msg 钩子 commitlint。我的推荐组合是 Husky 负责 Git Hooks 管理commitlint 负责校验提交信息是否符合 Conventional Commits 规范。安装和配置大致是这样的npm install --save-dev husky commitlint/cli commitlint/config-conventional npx husky add .husky/commit-msg npx --no -- commitlint --edit $1然后在项目根目录创建commitlint.config.jsmodule.exports { extends: [commitlint/config-conventional] };这样配置之后任何人不管用什么方式提交只要提交信息不符合规范commit-msg 钩子就会直接报错提交被中断。Commitizen 是引导Husky Commitlint 是强制两者配合才算完整的规范闭环。我带的项目里就这么干能走git cz的用交互式表单非要写裸命令的不规范的提交根本进不了 Git 历史。4. 交互式提交深度实操一步步拆解4.1 启动交互式提交的三种方式初始化好适配器之后启动交互式提交有以下三种常见方式git cz npx cz npm run commitgit cz是全局安装 Commitizen 时提供的 Git 子命令体验最顺滑npx cz适合不想全局安装、直接调用项目 node_modules 里的命令npm run commit则是你已经在 package.json 中配置了commit: cz脚本之后的等价方式。三种方式本质最后都是调用 Commitizen 的 CLI 入口。启动之前别忘了git add暂存你要提交的文件。Commitizen 的交互流程虽然不检查暂存区内容但它在生成提交信息后执行的是git commit如果暂存区为空最终会得到nothing to commit的报错体验很割裂。我一般是先git add .或按需要git add file确认git status里列出了预期的文件再跑npx cz。4.2 六道必答题逐项解析我把实际交互中最常见的六个问题逐一拆一下这里填充的是我对每个字段的理解和填写建议而且这些理解同样适用于你以后手动写提交信息。第一问是提交类型选择。默认列表是feat、fix、docs、style、refactor、perf、test、build、ci、chore、revert。选错类型是很常见的事划重点新功能用feat修 bug 用fixCSS 调整这类纯粹改变外观但不改逻辑的用style而重构逻辑、不改变外部行为和功能的是refactor。很多人会把style当成调整了一些样式代码来用但其实按严格语义样式相关的调整通常应该归到chore或随功能提交style更多指代码格式化、分号、空格这类不改变运行逻辑的改动。第二问是 scope 范围。它对应括号里的模块名比如fix(login): ...中的login就是 scope表示影响登录模块。scope 在可填可不填之间我建议如果这次改动影响明显集中的某个模块就填如果跨了多个模块或者整体性比较强留空完全没问题。不要为了填而填随便编一个不存在的模块名比留空更难维护。第三问是 subject 标题。它要求用祈使句比如add user login endpoint而不是added user login endpoint或adding user login endpoint。原因是 Git 本身在交互式提交时推荐的就是命令式风格这样整个git log读起来像如果应用这个提交它将……语义更加统一。标题同样不要加句号保持精简中文或英文都行但建议一个项目里语言统一。英文小写开头在当前生态里最通用中文则没有这个限制。第四问是 body 详细描述。这里才是写背景、写细节的地方。值得写的内容包括这个改动的动机是什么解决了什么具体问题做了哪些关键实现决策以及有哪几个重点注意点。一个常见的误区是 body 写得太长讲了一堆过程性废话。提交信息的正文不是周报它是给未来读者看的写清楚为什么这么做比写清楚我一步步做了什么更有价值。第五问是是否包含破坏性变更。这里指 API 不兼容、数据库结构变化、配置项删除这类会破坏现有功能的情况。如果选了是Commitizen 会额外要求你写一段破坏性说明最终会作为BREAKING CHANGE出现在 footer 里。破坏性变更在语义化版本里意味着大版本号必须升主版本所以这一问不能糊弄。我见过的绝大多数项目的隐含问题就是升级依赖后接口行为变了但谁都没填这一项等别人上线才发现接不上了。第六问是关联的 issue。它支持#123这种格式。填写后会生成Closes #123这样的 footer。要注意的是很多代码托管平台通过这个Closes关键字在合并提交时自动关闭对应 issue所以如果你不想在合并时自动关 issue可以改用Related to #123这种描述但 Commitizen 默认生成的肯定是Closes。团队协作时建议约定清楚什么情况下用 closes什么情况下只引用。4.3 一个完整提交的生成过程演示光说不练假把式我们走一个具体的场景。假设你在开发一个用户系统这次修复了 token 刷新并发请求时出现的竞态问题你在交互界面做以下选择提交类型fixscope填写authsubject填写fix token refresh race conditionbody填写The token refresh request could fire multiple times before the first response returns, causing stale refresh token to be stored and the user to be logged out unexpectedly.破坏性变更选择No关联 issue选择Yes并填写#42Commitizen 生成的完整提交信息如下fix(auth): fix token refresh race condition The token refresh request could fire multiple times before the first response returns, causing stale refresh token to be stored and the user to be logged out unexpectedly. Closes #42之后 Commitizen 会调用git commit真正完成提交。此时在git log --oneline看到的是abcd123 fix(auth): fix token refresh race condition一眼就能看懂这次提交做了什么、影响哪个模块、关联哪个 issue。配合自动生成 Changelog 的流程这条信息还能被工具直接提取为一条 release note。4.4 交互过程中的实操心得实际用久了你会发现Commitizen 的交互流程也有值得微调的地方。比如 subject 的 87 字符限制在写长项目名的模块时会很憋屈。我碰到过 scope 写一个很长的包名结果 type 和 scope 占了大半行subject 只剩十几个字符可写的情况。这种时候我的处理方式是把 scope 简写或直接留空完整包名放到 body 里补充说明。还有个细节Commitizen 的交互在终端宽度不够的时候个别选项列表会显示得很挤容易看错。我一般把终端窗口拉宽一点再执行避免因为视觉错乱选错类型。这在 CI 里不会发生但在开发机上确实是个真实存在的体验问题。5. 常见问题与排查技巧实录5.1 配置与安装问题速查我整理了这几类在真实项目里反复出现的问题尤其是多人协作、多包管理工具并存的情况下每个都值得收藏一份现象可能原因处理方式执行npx cz后只显示一行 Usage 就退出项目里没初始化适配器先执行npx commitizen init cz-conventional-changelog --save-dev --save-exactconfig.commitizen.path指向的包找不到适配器被 pnpm 的 strict peer 机制拦截手动把 path 改为cz-conventional-changelog作为包名或检查.npmrc的 hoist 策略全局安装了git cz却报 command not foundnpm 全局 bin 目录不在 PATH 中确认npm config get prefix对应的 bin 目录已加入 PATHnpm run commit弹出代码编辑器npm script 环境里 cz 正常但某一步远程配置影响了 git commit检查 core.editor 配置必要时设置git config core.editor vi对比commitlint 报错但提交信息明明符合规范commitlint 配置和适配器类型列表不一致统一commitlint.config.js的types与适配器types其中我自己踩过最大的坑就是 pnpm。pnpm 的 symlink 结构不像 npm 那样把所有依赖平铺在node_modules根目录下cz-conventional-changelog有时会因为它依赖的某个包没被显式声明而找不到。后来我干脆在根目录的package.json里显式声明适配器包并把config.commitizen.path写成cz-conventional-changelog包名而不是相对路径才稳定下来。5.2 使用与交互问题排查交互流程本身相对稳定但有几个使用层面的问题值得记录它们更多是怎么用才顺手层面的现象可能原因处理方式回答完所有问题提交却失败并提示权限错误git commit 权限或 commit-msg 钩子报错先单独跑git commit -m test看是否也有钩子问题逐层排查想修改前一次提交信息但生成 commit 时发现已经推送到远端提交后立刻 push 了用git commit --amend配合cz重新生成信息未推送前使用已推送的走 revert 或 force push需团队约定交互问答里没有我想要的类型适配器类型列表不满足需求改用cz-customizable在.cz-config.js里自定义 type 列表或 fork 适配器中文 title 在部分终端显示乱码终端编码和 Git 编码不一致建议团队统一用英文提交信息或者统一设置终端 UTF-8 编码这里我要提醒一句Commitizen 生成的提交信息本质是一条字符串它不关心你用什么语言写 subject 和 body。你的团队用中文提交完全没问题。但需要考虑的问题是后续工具链比如commitlint默认的类型检查和 changelog 生成工具对非英文文本的处理。我的经验是subject 尽量用英文body 里可以混写中文两边不耽误。5.3 排查思路从报错信息出发在社区里看别人报错我发现 90% 的 Commitizen 问题集中在适配器没配好和钩子冲突两类。适配器没配好的典型特征就是执行npx cz后没有出现交互问答只是一闪而过或者打印 usage钩子冲突的典型特征则是问答流程顺利走完最后git commit时被 commit-msg 钩子拦下报出subject may not be empty这种 commitlint 错误。排查的时候我的顺序固定是先验证npx cz能不能进入交互界面不行就查config.commitizen.path能进交互但提交失败就查 commit-msg 钩子钩子本身配置没问题就查 commitlint 规则是否需要针对 team 定制。这条路走下去基本不会卡壳。6. 实战经验与团队落地建议6.1 提交信息自动生成 Changelog 和版本号Commitizen 生成的标准提交信息更大的价值在于它能被下游工具直接消费。我最常用的组合是standard-version它根据git log中的feat、fix、BREAKING CHANGE类型自动判断是升主版本、次版本还是修订版本并生成一份像样的 CHANGELOG.md。在项目里配置standard-version之后新版本发布基本是这样的流程git add . npx cz npx standard-version git push --follow-tags origin mainstandard-version会扫描从上一个 tag 以来的所有提交信息从中提取feat、fix、BREAKING CHANGE、Closes #xx等标记自动决定版本号并生成 changelog 内容。如果你想升某个指定的版本可以加参数比如--release-as minor。这意味着团队只要保证 Commitizen 交互阶段填写信息是准确的从提交到版本发布之间几乎所有手工整理工作都不需要了。6.2 团队落地的节奏与分寸在团队里推 Commitizen最大的敌人不是技术难度而是积极性。强制所有人都立刻使用往往会引发逆反心理反而破坏流程推行。我见过推行成功的团队实际节奏是这样的第一个阶段只在一个核心项目中引入 Commitizen让小组里两三个积极尝鲜的人先用起来。第二个阶段用 Husky commitlint 在 commit-msg 钩子层做硬校验但把规则放宽先只检查 type 字段是否存在、subject 是否非空逐步从不规范提交中收集实际错误样例再收紧。第三个阶段等大家都体会到自动生成 changelog和快速回溯变更的好处之后再统一要求 scope 必填或者 body 必填。这个节奏的本质是先用收益牵引再用约束兜底。Commitizen 本身是收益导向的工具它让填写规范提交信息变得毫不费力Husky 和 commitlint 才是约束导向的工具它们守住底线。两者配合不至于一开始就把团队逼出不适感。6.3 进阶扩展自定义适配器与 Monorepo 实践如果团队对默认的cz-conventional-changelog提问文案不满意比如你希望中文提示、希望新增一类自定义 type用cz-customizable可以很快实现。安装之后写一份.cz-config.jsmodule.exports { types: [ { value: feat, name: feat: 新功能 }, { value: fix, name: fix: 修复 bug }, { value: docs, name: docs: 文档变更 }, { value: refactor, name: refactor: 重构不是新增功能也不是修复 } ], allowBreakingChanges: [feat, fix], subjectLimit: 100 };这种配置在需要多语言提示、或者想精简 type 列表的团队里很实用。需要注意的一点是如果你改了types列表commitlint.config.js里的规则也得同步改否则就出现了Commitizen 允许的提交commitlint 拒绝的尴尬局面。我见过不止一个项目踩这个坑改完.cz-config.js忘了同步 commitlint最终白白浪费时间排查。Monorepo 场景下我的建议是在根目录配一套 Commitizen子包不重复配置避免仓库里出现多个config.commitizen路径导致执行乱套。配合pnpm时注意用pnpm dlx commitizen init这种形式初始化手动在子包当作独立包发布时再考虑在子包内单独配置。6.4 最后谈谈我个人对规范提交的体会这套工具链我前前后后用了多年从最开始嫌弃多问几个问题浪费时间到现在已经完全离不开。最大的心得倒不是某个具体的配置项而是一个观念转变提交信息不是写给 Git 看的元数据而是写给未来的自己和其他协作者的便签。Commitizen 的交互式提交真正解决的不是格式规范问题而是格式成本问题——过去你要记住一堆规则现在只需要在问答里如实选择、如实填写。再配合 commitlint 兜底团队里用不用 Commitizen 已经不再是个可选项因为不用它你几乎写不出能通过校验的提交信息。如果你正准备在团队里推行这套流程我建议从小范围开始先让两三个人用起来产生几条高质量提交信息作为范例其他人看到git log的整洁度自然会被吸引。工具可以快速配置习惯才是最难养成的。一旦大家从交互式提交里获得了可检索、可回溯、可自动生成 changelog的反馈这套流程基本上就不需要你再操心了。
阅读完成 · 觉得有帮助？
