git commit提交规范和规范校验
时间:2020-07-15
本文章向大家介绍git commit提交规范和规范校验 ,主要包括git commit提交规范和规范校验 使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。
一、目的
在多人协作项目,如果代码风格统一、提交信息准确,那么在后期协作以及BUG处理时会更加方便。
格式化的commit message有以下几个好处:
1. 方便快速检索历史提交信息,只看行首即可知晓commit的目的
git log HEAD --pretty=format:%s
2. 可以过滤某些commit(比如文档更新),便于快速查找信息
git log HEAD --pretty=format:%s --grep 新功能
3. 可以直接从commit生成changelog,说明与上一版本发布的差异
通过changelog,测试知晓本次变更修改范围
二、格式
每一次提交,信息都必须遵循commit信息格式,包含Header、Body、Footer三个部分。
三、工具
3.1 依赖安装
# 安装所需依赖, changelog-sn至少2.x版本
npm install -D changelog-sn standard-version
3.2 配置commitlint和commitizen
代码仓库根目录创建文件
.commitlintrc.js
和.czconfigrc.js
3.2.1 配置.commitlintrc.js内容
module.exports = Object.assign({}, require('changelog-sn/lib/lint'), {
rules: {
'subject-empty': [2, 'never'],
'type-empty': [2, 'never'],
'scope-empty': [2, 'never'],
'type-enum': [
2,
'always',
[
'新功能',
'修复',
'优化',
'重构',
'文档',
'chore',
'revert',
'WIP',
'docs',
'build',
'release'
]
]
}
})
3.2.2 配置.czconfigrc.js
module.exports = {
types: [
{ value: '新功能', name: '新功能 : 新增加一个功能' },
{ value: '修复', name: '修复 : 一个 bug 修复' },
{ value: '优化', name: '优化 : 提升性能的代码更改' },
{ value: '重构', name: '重构 : 不涉及修复bug和新功能开发的代码更改' },
{ value: '文档', name: '文档 : 只有文档发生改变' },
{ value: 'chore', name: '构建 : 修改持续集成的配置文件和脚本' },
{ value: 'revert', name: '撤销 : 撤销一个历史提交' },
{ value: 'WIP', name: '待完成 : 研发中的提交备份' }
],
messages: {
type: '选择你提交的信息类型:',
scope: '选择本次提交的改变所影响的范围?',
customScope: '本次提交的改变所影响的范围?',
subject: '写一个简短的变化描述,尽量包含主谓宾结构,杜绝简单的单词:\n',
body: '提供更详细的变更描述 (按 enter 跳过). 使用 "|" 换行:\n',
breaking: '列出所有的不兼容变更 (按 enter 跳过):\n',
footer: '列出此次改动解决的所有 issues (如:"#123, #234")(按 enter 跳过):\n',
confirmCommit: '确认提交以上内容信息?'
},
allowBreakingChanges: ['refactor', 'chore'],
breakingPrefix: 'WARNING:',
skipQuestions: ['body'],
subjectLimit: 100,
breaklineChar: '|',
footerPrefix: 'CLOSED:'
}
3.2.3 配置package.json
{
"scripts": {
"log": "changelog-sn -i CHANGELOG.md -s -r 2",
"cz": "git add . && git cz"
},
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
},
"config": {
"commitizen": {
"path": "./node_modules/cz-customizable"
},
"cz-customizable": {
"config": "./.czconfigrc.js"
}
},
"devDependencies": {
"changelog-sn": "2.0.5"
}
}
作者:逆黄
链接:https://www.jianshu.com/p/d20ecbc66ae1
来源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
原文地址:https://www.cnblogs.com/linwenbin/p/13308654.html
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- OpenShift应用发布和运维设计
- Android:依赖Module的问题汇总
- Android:加载网图时精确获取图片格式
- Android:8.0中未知来源安装权限变更
- Android:RippleDrawable 水波纹/涟漪效果
- Android:Chip、ChipGroups、ChipDrawable
- Android9.0 使用 AndroidVideoCache 时不能缓存/播放视频的解决
- Android:流式布局实现总结
- 跨域问题汇总
- 优化 Docker 镜像大小常见方法
- 第10期:选择合适的表空间
- 在 Kubernetes 上编排 MongoDB 集群
- k8s技术圈一周精选[第7期]
- TypeScript namespace 命名空间
- 从Pytorch 的ONNX到OpenVINO中IR中间层