千锋教育-做有情怀、有良心、有品质的职业教育机构

手机站
千锋教育

千锋学习站 | 随时随地免费学

千锋教育

扫一扫进入千锋手机站

领取全套视频
千锋教育

关注千锋学习站小程序
随时随地免费学习课程

当前位置:首页  >  技术干货  > 使用commitizen规范Git提交说明

使用commitizen规范Git提交说明

来源:千锋教育
发布人:qyf
时间: 2022-10-10 17:11:53 1665393113

  前言

  Git 是目前世界上最先进的分布式版本控制系统(没有之一)。

  Git 每次提交代码时,都需要写 Commit Message (提交说明),否则就不允许提交。

  $ git commit -m '第一次提交'

  在工作中一份清晰简介规范的 Commit Message 能让后续代码审查、信息查找、版本回退都更加高效可靠。

图片37

  Commit Message 的标准格式

  Commit Message 标准格式包括三个部分:Header,Body,Footer

38

  其中,Header 是必需的,Body 和 Footer 可以省略

  一、Header

  Header 部分只有一行,包括三个字段:type(必需)、scope(可选)、subject(必需)

  1. type

  用于说明类型。可分以下几种类型

39

  2. scope

  用于说明影响的范围,比如数据层、控制层、视图层等等。

  3. subject

  主题,简短描述。一行

  二、Body

  对 subject 的补充。可以多行。

  三、Footer

  主要是一些关联 issue 的操作。

  四、Commitizen

  Commitizen 是一个撰写符合上面 Commit Message 标准的一款工具。

  一、安装

  全局安装

  1. 下载

  npm install -g commitizen cz-conventional-changelog

  2. 创建 ~/.czrc 文件,写入如何内容

  { "path": "cz-conventional-changelog" }

  3. 这时就可以全局使用 git cz 命令来代替 git commit 命令了

  项目局部使用

  1. 下载 commitizen

  npm install --save-dev commitizen

  2. 配置,打开项目的 package.json 文件,配置如下。

  {

  "scripts": {

  "commit": "git-cz",

  },

  "config": {

  "commitizen": {

  "path": "node_modules/cz-conventional-changelog"

  }

  }

  }

  3. 这时就可以使用 npm run commit 脚本了

  二、使用

  全局安装使用 git cz 来代替 git commit

  局部安装使用 npm run commit 脚本来代替 git commit

  三、详细步骤说明

  1. 选择此次提交的类型

  注意:不要使用 git bash (不能进行键盘上下选择)

40

  2. 输入这次提交的影响范围

  如没有,可直接回车跳过

41

  3. 输入这次提交的主题

  注意:精简,字数限制。不可跳过

42

  4. 输入这次提交的详细描述

  如没有,可直接回车跳过

43

  5. 这次提交是否有突破性变化(是否不向下兼容)

  注意:如果输入 y ,会有新的提示

44

  6. 这次提交是否有关联的 issues

  注意:如果输入 y ,会有新的提示

45

  7. 完成

46

  8. 查看日志

47

tags:
声明:本站稿件版权均属千锋教育所有,未经许可不得擅自转载。
10年以上业内强师集结,手把手带你蜕变精英
请您保持通讯畅通,专属学习老师24小时内将与您1V1沟通
免费领取
今日已有369人领取成功
刘同学 138****2860 刚刚成功领取
王同学 131****2015 刚刚成功领取
张同学 133****4652 刚刚成功领取
李同学 135****8607 刚刚成功领取
杨同学 132****5667 刚刚成功领取
岳同学 134****6652 刚刚成功领取
梁同学 157****2950 刚刚成功领取
刘同学 189****1015 刚刚成功领取
张同学 155****4678 刚刚成功领取
邹同学 139****2907 刚刚成功领取
董同学 138****2867 刚刚成功领取
周同学 136****3602 刚刚成功领取
相关推荐HOT