飞雪连天射白鹿,笑书神侠倚碧鸳

0%

git提交规范

规范的git信息在多人共同协作开发项目时很有帮助
commitizen工具用于规范提交信息

分支命名,个人习惯:feature/需求_昵称

  • feat: 新增一个功能
  • fix: 修复bug
  • style: 仅仅修改了空格、格式缩进等等,不改变代码逻辑
  • docs: 仅仅修改了文档,比如README, CHANGELOG, CONTRIBUTE等等
  • test: 测试用例,包括增加缺失用例或者修正测试用例
  • perf: 优化相关,比如提升性能、体验
  • refactor: 代码重构,没有加新功能或者修复bug

commitizen

1
2
3
npm install commitizen -D # 提交时填写所有必需的提交字段
npm install cz-conventional-changelog -D # 用来规范提交信息
npm install -S conventional-changelog-cli # 从git metadata生成变更日志

在package.json中添加命令

1
2
3
4
5
6
7
8
9
10
11
{
"scripts":{
"commit": "git-cz", // 替换git commit -m.
"genlog": "conventional-changelog -p angular -i CHANGELOG.md -s"
},
"config":{
"commitizen":{
"path": "./node_modules/cz-conventional-changelog"
}
}
}

规范提交文案

npm run commit

每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。

包括三个字段:type(必需)、scope(可选)和subject(必需)

type

类型feat/fix/test等

scope

说明 commit 影响的范围,比如数据层、控制层、视图层等等

subject

commit 目的的简短描述,不超过50个字符,动词开头

Body

详细描述,可以分成多行

  • 不兼容变动,理由和方法
  • 关闭 Issue:Closes #234

生成日志

npm run genlog

听说,打赏我的人最后都找到了真爱
↘ 此处应有打赏 ↙
// 用户脚本