如何规范代码提交?

123 阅读1分钟

背景

工作中一般会提到工程化这个概念,这个概念很宽泛,我们今天主要聊聊代码提交规范。

为什么要规范化提交信息?

最根本的原因就是能大概看懂每提交的作用,为了应对代码回滚、问题排查、了解上线内容等。如果提交记录中都是各种空格、人名等。请问你最近上线了哪些内容、请回滚某个需求等,只能翻看每次提交里面的所有修改然后再去猜。

如何对代码提交进行强校验?

我觉得只要分为两个部分:

1、开发端,对代码提交的内容进行校验, 校验不通过则禁止提交。需要使用 commitlint, husky,网上有很多优秀的文章,这里不展开

2、服务端,通过使用代码仓库的webhook触发我们的服务,对提交内容格式错误、大量文件修改的提交、文件删除提交、文件重命名提交等高危操作,进行钉钉告警。

拥抱开源

其实不按规则提交的本质就是,为了应对这种情况,笔者开源了一款工作流插件rich-workflow

1、创建文件夹 image.png

2、使用命令rich commit,这里就会出现交互,让我们选择修改的类型 image.png

3、选择影响的范围(选填),我们这里新增了index.html image.png

4、输入我们的提交信息 image.png

5、成功 image.png