🔥码云GVP开源项目 12k star Uniapp+ElementUI 功能强大 支持多语言、二开方便! 广告
# 为什么需要代码提交规范 在团队协作开发时,每个人提交代码时都会写 commit message。 每个人都有自己的书写风格,翻看我们组的git log, 可以说是五花八门,十分不利于阅读和维护。 一般来说,大厂都有一套的自己的提交规范,尤其是在一些大型开源项目中,commit message 都是十分一致的。 因此,我们需要制定统一标准,促使团队形成一致的代码提交风格,更好的提高工作效率,成为一名有追求的工程师。 # 业界通用的 git 提交规范有哪些? ## 1.[commitizen](https://www.npmjs.com/package/commitizen) [AngularJS](https://github.com/angular/angular/commits/master)在 github上 的提交记录被业内许多人认可,逐渐被大家引用。 <br /> **格式:** ``` type(scope) : subject ``` (1) type(必须) : commit 的类别,只允许使用下面几个标识: * feat : 新功能 (feature) * fix : 修复bug * docs : 文档改变 * style : 代码格式改变 * refactor : 某个已有功能重构 * perf : 性能优化 * test : 增加测试 * build : 改变了build工具 如 grunt换成了 npm * revert : 撤销上一次的 commit * chore : 构建过程或辅助工具的变动 ( 2 ) scope(可选) : 用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。 ( 3 ) subject(必须) : commit 的简短描述,不超过50个字符。 **示例** ``` git commit -m "feat: 新增提现功能" git commit -m "fix: 修复提现余额不足依然可以申请问题" ``` ## 参考 [git commit 代码提交规范](https://segmentfault.com/a/1190000017205604)