Git代码提交规范

随着团队不断扩大,git 的 commit 信息需要按照一定的格式规范,以便在需要的时候方便使用。提交信息可以方便的定位问题, 代码 review 的时候也知道了该次 commit 干了什么,所以 commit 标准化好处很多,不再多说

实现

    结合 git hook 实现在 git commit 阶段检查输入是否符合规范,符合通过,反之提示

工具

commitlint:用于检查提交信息, 定义「规范」、「分类」
husky:hook 工具,用于 git-commit 和 git-push 阶段

规范

根据 commitlint-config-conventional(基于Angular约定)的常见类型如下:

build:修改项目的的构建系统(xcodebuild、webpack、glup等)的提交 •
ci:修改项目的持续集成流程(Kenkins、Travis等)的提交
chore:构建过程或辅助工具的变化 •
docs:文档提交(documents)
feat:新增功能(feature)
fix:修复 bug •
perform:性能、体验相关的提交
refactor:代码重构
revert:回滚某个更早的提交 •
style:不影响程序逻辑的代码修改、主要是样式方面的优化、修改
test:测试相关的开发

不建议

如果某次提交想禁用校验,可以添加参数 --no-verify。git commit --no-verify -m “xxx”

发布了214 篇原创文章 · 获赞 371 · 访问量 92万+

猜你喜欢

转载自blog.csdn.net/u013718120/article/details/104656839