在团队协作开发时,每个人提交代码时都会写 commit message。
每个人都有自己的书写风格,翻看我们组的git log, 可以说是五花八门,十分不利于阅读和维护。
一般来说,大厂都有一套的自己的提交规范,尤其是在一些大型开源项目中,commit message 都是十分一致的。
因此,我们需要制定统一标准,促使团队形成一致的代码提交风格,更好的提高工作效率,成为一名有追求的工程师。
业界通用的git提交规范
build/Build:构建相关
chore/Chore:其他复杂事务的变动
ci/CI:ci 相关的变动
docs/Docs:文档书写改动
feat/Feat:新功能,新特性(体现在 changelog)
fix/Fix:Bug修复(体现在 changelog)
perf/Perf:性能优化相关(体现在 changelog)
refactor:重构(既不是新功能,也不是修改 bug 的代码变动)
revert/Revert:代码回滚(体现在 changelog)
style/Style:Code Style 修改
test/Test:测试相关
temp/Temp:临时提交
借助插件(git-commit-plugin For Vscode)
如何使用
- 首先我们需要去 Vscode 插件市场搜索 git-commit-plugin 并且进行安装。
- 安装完之后可以使用组合键 Command + Shift + P 呼出 指令行,并键入指令 show git commit template 或者点击 git 插件栏上的小图标唤醒插件界面。
- 根据自己当前提交所要表达的意义,选择对应的 type 类型去编写 commit 信息