温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

Git提交规范的方法有哪些

发布时间:2021-10-23 15:33:14 来源:亿速云 阅读:147 作者:iii 栏目:编程语言

本篇内容主要讲解“Git提交规范的方法有哪些”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“Git提交规范的方法有哪些”吧!

        git是现在市面上最流行的版本控制工具,书写良好的commit message能大大提高代码维护的效率。但是在日常开发中由于缺少对于commit message的约束,导致填写内容随意、质量参差不齐,可读性低亦难以维护。在项目中引入commit message规范已是迫在眉睫。

一、市场主流规范

        现在市面上比较流行的方案是约定式提交规范(Conventional Commits),它受到了Angular提交准则的启发,并在很大程度上以其为依据。约定式提交规范是一种基于提交消息的轻量级约定。它提供了一组用于创建清晰的提交历史的简单规则;这使得编写基于规范的自动化工具变得更容易。这个约定与SemVer相吻合,在提交信息中描述新特性、bug 修复和破坏性变更。它的 message 格式如下:

Git提交规范的方法有哪些

二、git commit 规范化工具 —— commitizen

1. 全局安装commitizen & cz-conventional-changelog

        commitizen是一个撰写合格commit message的工具,用于代替git commit 指令,而cz-conventional-changelog适配器提供conventional-changelog标准(约定式提交标准)。基于不同需求,也可以使用不同适配器。

Git提交规范的方法有哪些

        安装完毕后,可直接使用git cz来取代git commit。
        全局模式下,需要 ~/.czrc 配置文件, 为commitizen指定Adapter。                   

2. 项目内安装commitlint & husky

        commitlint负责用于对commit message进行格式校验,husky负责提供更易用的git hook。

Git提交规范的方法有哪些

        commitlint只能做格式规范,无法触及内容。对于内容质量的把控只能靠我们自己。             

3. 添加相应配置

        创建commitlint.config.js

Git提交规范的方法有哪些

        引入 husky

Git提交规范的方法有哪些

4. 使用

        执行git cz进入interactive模式,根据提示依次填写

Git提交规范的方法有哪些

        生成的commit message格式如下:

Git提交规范的方法有哪些

        填写完毕后,husky会调用commitlint对message进行格式校验,默认规定type及subject为必填项。

        任何git commit指令的option都能用在 git cz指令上, 例如git cz -a

三、Commit message规范在rrd-fe落地使用

1. type

        type为必填项,用于指定commit的类型,约定了feat、fix两个主要type,以及docs、style、build、refactor、revert五个特殊type,其余type暂不使用。

Git提交规范的方法有哪些

        当一次改动包括主要type与特殊type时,统一采用主要type。

2. scope

        scope也为必填项,用于描述改动的范围,格式为项目名/模块名,例如:node-pc/commonrrd-h6/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。参考文档: User Docs | GitLab

        填写方式例如:

Git提交规范的方法有哪些

四、示例

1、完整的commit message示例

Git提交规范的方法有哪些

2、相应的git log

Git提交规范的方法有哪些

到此,相信大家对“Git提交规范的方法有哪些”有了更深的了解,不妨来实际操作一番吧!这里是亿速云网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

git
AI