大厂开发规范-如何规范的提交Git

多人协作开发提交代码通常是遵循约定式提交规范,如果严格安照约定式提交规范, 手动进行代码提交的话,那么是一件非常痛苦的事情,但是 Git 提交规范的处理又势在必行,那么怎么办呢?

经过了很多人的冥思苦想,就出现了一种叫做 Git 提交规范化工具 的东西,而我们要学习的 Commitizen 就是其中的佼佼者!

1. 全局安装 commitizen

javascript 复制代码
npm install -g commitizen@4.2.4

安装成功后如下图所示:

2. 安装并配置 cz-customizable 插件

2.1. 使用 npm 下载 cz-customizable

javascript 复制代码
npm i cz-customizable@6.3.0 --save-dev

使用以上命令在项目的命令行中安装插件,如下图所示:

2.2. 添加以下配置到 package.json 中

javascript 复制代码
"config": {
    "commitizen": {
        "path": "node_modules/cz-customizable"
    }
}

配置后如下图所示:

3. 创建 cz-config.js 自定义提示文件

项目根目录下创建 .cz-config.js 自定义提示文件,添加配置如下:

javascript 复制代码
module.exports = {
    // 可选类型
    types: [
        { value: 'feat', name: 'feat:     新功能' },
        { value: 'fix', name: 'fix:      修复' },
        { value: 'docs', name: 'docs:     文档变更' },
        { value: 'style', name: 'style:    代码格式(不影响代码运行的变动)' },
        {
            value: 'refactor',
            name: 'refactor: 重构(既不是增加feature,也不是修复bug)'
        },
        { value: 'perf', name: 'perf:     性能优化' },
        { value: 'test', name: 'test:     增加测试' },
        { value: 'chore', name: 'chore:    构建过程或辅助工具的变动' },
        { value: 'revert', name: 'revert:   回退' },
        { value: 'build', name: 'build:    打包' }
    ],
    // 消息步骤
    messages: {
        type: '请选择提交类型:',
        customScope: '请输入修改范围(可选):',
        subject: '请简要描述提交(必填):',
        body: '请输入详细描述(可选):',
        footer: '请输入要关闭的issue(可选):',
        confirmCommit: '确认使用以上信息提交?(y/n/e/h)'
    },
    // 跳过问题
    skipQuestions: ['body', 'footer'],
    // 描述提交长度限制
    subjectLimit: 72
}

4. 使用 git cz 代替 git commit

提交代码时使用 git cz 代替 git commit,即可看到提示内容。

到这里我们就已经可以实现了规范化的提交诉求了,但是当前依然存在着一个问题,那就是我们必须要通过 git cz 指令才可以完成规范化提交。

那么如果有马虎的同事,它们忘记了使用 git cz 指令,直接就提交了怎么办呢?

那么有没有方式来限制这种错误的出现呢?

我们可以通过Git Hooks来防止这种问题发生。

相关推荐
chhanz4 小时前
git/github入门基操(终端版)
git·github
林晓lx6 小时前
使用Git钩子+ husky + lint语法检查提高前端项目代码质量
前端·git·gitlab·源代码管理
诸葛思颖7 小时前
一个本地 Git 仓库关联多个远程仓库
git
StarShip10 小时前
git commit --amend 之后,想要修改为git commit , 如何处理?
git
dnpao15 小时前
在服务器已有目录中部署 Git 仓库
运维·服务器·git
__Witheart__15 小时前
Git 如何从某个 commit 新建分支
git
Klaus_Wei1 天前
git 高级命令模式典型应用--“同步云端 + 清理垃圾分支”的一键命令
git·git高级用法·git同步云端·git清理垃圾分支
妙娲种子1 天前
配置git/创建第一个智能相册保存快照
git
what_20181 天前
git一个账号在两台电脑登录 出现不同用户名
git
困鲲鲲1 天前
ROS2系列 (13) : 常用Git指令入门(本地Git)
git·ros2