springboot去掉git版本控制_关于 Git 提交这些规范,你都遵守了吗?
来源:人人贷大前端技术中心http://juejin.im/post/5d0b3f8c6fb9a07ec07fc5d0
git是现在市面上最流行的版本控制工具,书写良好的commit message能大大提高代码维护的效率。但是在日常开发中由于缺少对commit message的约束,导致填写内容随意、质量参差不齐,可读性低亦难以维护。
在项目中引入commit message规范已是迫在眉睫。
- 用什么规范?
- Quick Start
- 1. 全局安装commitizen & cz-conventional-changelog
- 2. 项目内安装commitlint & husky
- 3. 添加相应配置
- 4. 使用
- Commit message规范在rrd-fe落地使用情况
- 1. type
- 2. scope
- 3. body
- 4. break changes
- 5. affect issues
- 示例
- 扩展阅读
用什么规范?
现在市面上比较流行的方案是约定式提交规范
(Conventional Commits
),它受到了Angular提交准则
的启发,并在很大程度上以其为依据。约定式提交规范
是一种基于提交消息的轻量级约定。
它提供了一组用于创建清晰的提交历史的简单规则;这使得编写基于规范的自动化工具变得更容易。这个约定与SemVer
相吻合,在提交信息中描述新特性、bug 修复和破坏性变更。它的 message 格式如下:
<类型>[可选的作用域]: <描述>[可选的正文][可选的脚注]
Quick Start
1. 全局安装commitizen & cz-conventional-changelog
commitizen
是一个撰写合格commit message
的工具,用于代替git commit
指令,而cz-conventional-changelog
适配器提供conventional-changelog标准(约定式提交标准)。基于不同需求,也可以使用不同适配器。
npm install -g commitizen cz-conventional-changelog
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
安装完毕后,可直接使用git cz
来取代git commit
。
全局模式下,需要 ~/.czrc
配置文件, 为commitizen
指定Adapter
。
2. 项目内安装commitlint & husky
commitlint
负责用于对commit message
进行格式校验,husky
负责提供更易用的git hook
。
Use npm
npm i -D husky @commitlint/config-conventional @commitlint/cli
Use yarn
yarn add husky @commitlint/config-conventional @commitlint/cli -D
commitlint
只能做格式规范,无法触及内容。对于内容质量的把控只能靠我们自己。
3. 添加相应配置
创建commitlint.config.js
# In the same path as package.jsonecho 'module.exports = {extends: ["@commitlint/config-conventional"]};' > ./commitlint.config.js
引入husky
# package.json...,
"husky": {"hooks": {"commit-msg": "commitlint -e $GIT_PARAMS"}
}
4. 使用
执行git cz
进入interactive模式,根据提示依次填写
1.Select the type of change that you're committing 选择改动类型 (<type>)2.What is the scope of this change (e.g. component or file name)? 填写改动范围 (<scope>)3.Write a short, imperative tense description of the change: 写一个精简的描述 (<subject>)4.Provide a longer description of the change: (press enter to skip) 对于改动写一段长描述 (<body>)5.Are there any breaking changes? (y/n) 是破坏性修改吗?默认n (<footer>)6.Does this change affect any openreve issues? (y/n) 改动修复了哪个问题?默认n (<footer>)
生成的commit message格式如下:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
填写完毕后,husky
会调用commitlint
对message进行格式校验,默认规定type
及subject
为必填项。
任何git commit
指令的option
都能用在 git cz
指令上, 例如git cz -a
Commit message规范在rrd-fe落地使用情况
针对团队目前使用的情况,我们讨论后拟定了commit message
每一部分的填写规则。
1. type
type
为必填项,用于指定commit的类型,约定了feat
、fix
两个主要type
,以及docs、style、build、refactor、revert五个特殊type
,其余type
暂不使用。
# 主要type
feat: 增加新功能
fix: 修复bug# 特殊type
docs: 只改动了文档相关的内容
style: 不影响代码含义的改动,例如去掉空格、改变缩进、增删分号
build: 构造工具的或者外部依赖的改动,例如webpack,npm
refactor: 代码重构时使用
revert: 执行git revert打印的message# 暂不使用type
test: 添加测试或者修改现有测试
perf: 提高性能的改动
ci: 与CI(持续集成服务)有关的改动
chore: 不修改src或者test的其余修改,例如构建过程或辅助工具的变动
当一次改动包括主要type
与特殊type
时,统一采用主要type
。
2. scope
scope
也为必填项,用于描述改动的范围,格式为项目名/模块名,例如:node-pc/common
rrd-h5/activity
,而we-sdk
不需指定模块名。如果一次commit修改多个模块,建议拆分成多次commit,以便更好追踪和维护。
3. body
body
填写详细描述,主要描述改动之前的情况
及修改动机
,对于小的修改不作要求,但是重大需求、更新等必须添加body来作说明。
4. break changes
break changes
指明是否产生了破坏性修改,涉及break changes的改动必须指明该项,类似版本升级、接口参数减少、接口删除、迁移等。
5. affect issues
affect issues
指明是否影响了某个问题。例如我们使用jira时,我们在commit message
中可以填写其影响的JIRA_ID
,若要开启该功能需要先打通jira
与gitlab
。
参考文档:
https://docs.gitlab.com/ee/user/project/integrations/jira.html
填写方式例如:
re #JIRA_ID
fix #JIRA_ID
示例
完整的commit message示例
相应的git log
扩展阅读
conventional commits 必读
介绍约定式提交标准。
https://www.conventionalcommits.org/zh/v1.0.0-beta.3/
Angular规范 必读
介绍Angular标准每个部分该写什么、该怎么写。
https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines
@commitlint/config-conventional 必读
介绍commitlint的校验规则config-conventional,以及一些常见passes/fails情况。
https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum
推荐阅读(点击即可跳转阅读)
1.SpringBoot内容聚合
2.面试题内容聚合
3.设计模式内容聚合
4.Mybatis内容聚合
5.多线程内容聚合
springboot去掉git版本控制_关于 Git 提交这些规范,你都遵守了吗?相关推荐
- git gitee github等系列提交备注规范,提交规范(实用)
git gitee github等系列提交备注规范,提交规范(实用) <新功能|bug修复|文档改动|格式化|重构|测试代码>: (影响范围) <主题> # 解释为什么要做这些 ...
- eclipse查看git地址_使用Git进行版本控制
版本控制软件能够让我们拍摄处于可行状态下的项目的快照.更改项目(比如实现新功能)后,如果项目不能正常运行,可以恢复到前一个可行状态. 通过版本控制软件,我们可以无顾忌地改进项目,不再需要担心项目因为自 ...
- 中文提交到git乱码_解决Git 中文乱码问题
乱码情景对号入座和解决方案 乱码情景1 在cygwin中,使用git add添加要提交的文件的时候,如果文件名是中文,会显示形如274\232\350\256\256\346\200\273\347\ ...
- git文件共享_与Git共享文件
git文件共享 Git是那些设法将大量现代计算封装到一个程序中的罕见应用程序之一,最终成为许多其他应用程序的计算引擎. 尽管它最着名的是跟踪软件开发中的源代码更改,但它还有许多其他用途,可以使您的生活 ...
- git 删除git管理_使用Git管理多媒体文件
git 删除git管理 Git是专门为源代码版本控制而设计的,因此,主要用于纯文本格式的项目和行业很少使用它. 但是,异步工作流的优点很有吸引力,尤其是在越来越多的行业中,将严肃的计算与认真的艺术创作 ...
- Git版本控制总结——使用Git只要这篇就够了
**说明:**以下对Git的介绍只针对于Window系统,Linux和Mac系统暂不介绍: Git是什么? 1.什么是版本控制? 版本控制是指对若干个文件内容进行修改时,可以对修改的文件进行历史查阅和 ...
- git服务器查看用户信息,git 查看当前git用户_新Git用户使用方法
git 查看当前git用户 This post is a tutorial for new users to set up git and clone and use the first reposi ...
- Git版本控制管理(二)--git配置
在系统上安装好 Git后,还需要配置Git 环境. 每台计算机上只需要配置一次,程序升级时会保留配置信息,也可以在任何时候再次通过运行命令来修改它们. 配置文件位置 Git 自带一个 git conf ...
- Git版本控制管理——基本Git概念
基本概念 版本库 Git版本库(repository)只是一个简单的数据库,其中包括所有用来维护与管理项目的修订版本和历史信息.而Git版本不仅会维护项目整个生命周期的完整副本,还会提供版本库本身的副 ...
最新文章
- 学习笔记TF065:TensorFlowOnSpark
- [转载]使用RoboCopy 命令
- 在moss页面出错时,显示详细的错误信息.
- cacti监控一览无余
- 用Cython加速Python代码,快到起飞!
- web cache缓存设备的需求与讨论 ( Http://CACHE.MARASYSTEMS.ASIA )
- 计算机模拟分子设计,计算机模拟分子材料.pdf
- 对数据进行插入操作并且获取主键的值
- 今天提交了一个patch开心,呵呵
- python画轮廓_python 分割 画图像的轮廓 - 程序园
- 湖南师范大学数学与计算机学院郭水霞,湖南师范大学数学与计算机科学学院2013备考手册...
- linux系统下idea打包apk教程,intellij idea14打包apk文件和查看sha1值
- ORG LegacyCell for Mac - MS-20/Polysix音频合成器
- 三菱modbusRTU通讯实例_编程实例 | 台达PLC控制伺服项目接线及程序案例
- 联想小新打印机M7268W配置步骤
- python使用masscan扫描端口
- python低通滤波器设计(FIR, IIR)
- VMWare 下 CentOS 设置静态 IP 地址
- SAP中常用SM系列事务代码总结
- pageadmin CMS网站建设教程:附属表数据列表调用语法