开发项目前,团队之间肯定会对相关问题进行讨论,如前后端接口文档规范以及数据结构,前端编写代码规范以及提交规范等,今天我们就来讲使用git提交时如何进行统一规范。一般我们提交代码无非是,git add .、git commite 、git push等,想在git上看是新增页面还是bug修改,不能很好的进行标识,如:
那我们是否可以通过引入相应的规范进行统一约束和标识呢?
我们这里采用目前使用比较广泛的 commitizen 进行约束,下面就来讲解如何进行配置,由于 commitizen 是基于 nodejs 的工具,所以首先需要安装 node 环境。
在进行配置前需要查看git是否配置user.name 和user.email,可通过git config --list 查看,可通过以下进行全局配置
git config --global user.name "nameVal"
git config --global user.email "eamil@qq.com"
开始安装对应的包,可以进行全局和本地安装,全局安装以免以后再创建项目再进行配置:
npm install -g commitizen
npm install --global cz-conventional-emoji 其主要作用是为了对所提交代码进行bug、修改等进行标识,通俗点就是表情包
使用git 提交代码,通过 git cz
代替之前使用的git commit
命令,git cz
就会出现以下选项,用来生成符合格式的 Commit message(commitizen 与 emoji 结合)。如图:
Select the type of change that you're committing: (Use arrow keys)
? ? Feat: Introducing new features.? Bug: Fixing a bug.? Docs: Writing docs.? Style: Improving structure / format of the code.? UI: Updating the UI and style files.? Quickfix: Critical hotfix.?? Pref: Improving performance.
(Move up and down to reveal more choices)
通过以上操作,从而很直观的地标识我们git提交了什么,如图: