主题
git提交规范
一、使用 commitizen
https://blog.csdn.net/qq_22841387/article/details/125873023二、使用 husky 控制 git hook
https://blog.csdn.net/qq_22841387/article/details/125873897?spm=1001.2014.3001.5502三、pre-commit 检测代码规范
https://blog.csdn.net/qq_22841387/article/details/125876697?spm=1001.2014.3001.5502四、操作流程
git add .
npm run commit
git pushfeat:新功能(feature)
fix:修补 bug
docs:文档(documentation)
style:格式(不影响代码运行的变动)
refactor:重构(即不是新增功能,也不是修改 bug 的代码变动)
perf:提高性能的代码更改
test:增加测试
build:影响构建系统或外部依赖项的更改(示例范围:gulp、broccoli、npm)
chore:构建过程或辅助工具的变动
revert: 恢复以前的提交(回退)提示
项目安装了 husky 可以在 commit 时自动 lint 格式化代码 (vue and js file)
lint 期间 报错 无法解决 可以 在 package.json 中去除下面代码
json
"lint-staged": {
"*.{js,vue}": [
// 去掉这段
- "vue-cli-service lint"
]
}五、操作规范
type: 用于说明 commit 的类型。一般有以下几种:
feat: 新增feature
fix: 修复bug
docs: 仅仅修改了文档,如readme.md
style: 仅仅是对格式进行修改,如逗号、缩进、空格等。不改变代码逻辑。
refactor: 代码重构,没有新增功能或修复bug
perf: 优化相关,如提升性能、用户体验等。
test: 测试用例,包括单元测试、集成测试。
chore: 改变构建流程、或者增加依赖库、工具等。
revert: 版本回滚
scope: 用于说明 commit 影响的范围,比如: views, component, utils, test...
subject: commit 目的的简短描述