Conventional Commits specification(约定式提交)
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
------ 翻译 ------
<类型>[可选 范围]:<描述>
[可选 正文]
[可选 脚注]
使用Commitizen
进行代码提交(git commit)时commitizen会提交你在提交时填写所有必需的提交字段。
全局安装Commitizen
npm install -g commitizen
安装并配置cz-customizable插件
1) 使用npm下载cz-customizablenpm i cz-customizable --save-dev
2) 添加以下配置到package.json中
"config": { "commitizen": { "path": "node_modules/cz-customizable" } }
在项目根目录下创建
.cz-config.js
自定义提示文件module.exports = { // 可选类型 types: [ { value: 'feat', name: 'feat: 新功能' }, { value: 'fix', name: 'fix: 修复' }, { value: 'docs', name: 'docs: 文档变更' }, { value: 'style', name: 'style: 代码格式(不影响代码运行的变动)' }, { value: 'refactor', name: 'refactor: 重构(既不是增加feature,也不是修复bug)' }, { value: 'perf', name: 'perf: 性能优化' }, { value: 'test', name: 'test: 增加测试' }, { value: 'chore', name: 'chore: 构建过程或辅助工具的变动' }, { value: 'revert', name: 'revert: 回退' }, { value: 'build', name: 'build: 打包' } ], // 消息步骤 messages: { type: '请选择提交类型: ', customScope: '请输入修改范围(可选): ', subject: '请简要描述提交(必填): ', body: '请输入详细描述(可选): ', footer: '请输入要关闭的issue(可选): ', confirmCommit: '确认使用以上信息提交? (y/n)' }, // 跳过问题 skipQuestions: ['body', 'footer'], // subject文字长度默认是72 subjectLimit: 72 };
- 使用
git cz
代替 git commit
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。