sudo npm install -g commitizen cz-conventional-changelog
echo ‘{ “path”: “cz-conventional-changelog” }’ > ~/.czrc
1.1 分支规范
分支 命名 说明
主分支 main 主分支,所有提供给用户使用的正式版本,都在这个主分支上发布
开发主分支 dev 开发分支,永远是功能最新最全的分支
功能分支 feature-* 新功能分支,某个功能点正在开发阶段
发布版本 release-* 发布定期要上线的功能
修复发布版本分支 bugfix-release-* 修复测试bug
紧急修复分支 bugfix-master-* 紧急修复线上代码的 bug
分支 | 命名 | 说明 |
---|---|---|
2.1 Commit Message 规范
工具
npm install -g commitizen cz-conventional-changelog
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
git commit 时使用 Emoji
https://gitmoji.dev
npm i -g gitmoji-cli
在 Emoji 的名字前后个加上一个冒号
:name_of_emoj:
提交规范
执行 git cz 命令进行提交
type: commit 的类型
feat: 新特性
fix: 修改问题
refactor: 代码重构
docs: 文档修改
style: 代码格式修改, 注意不是 css 修改
test: 测试用例修改
chore: 其他修改, 比如构建流程, 依赖管理.
scope: commit 影响的范围, 比如: route, component, utils, build…
subject: commit 的概述, 建议符合 50/72 formatting
body: commit 具体修改内容, 可以分为多行, 建议符合 50/72 formatting
footer: 一些备注, 通常是 BREAKING CHANGE 或修复的 bug 的链接.
参考:
老鸟都应该注意的git 提交规范
别再乱提交代码了,看下大厂 Git 提交规范是怎么做的!
使用 commitizen 规范 Git 提交说明
git commit 时使用 Emoji