本篇內(nèi)容主要講解“Git提交規(guī)范的方法有哪些”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學(xué)習(xí)“Git提交規(guī)范的方法有哪些”吧!

蒙山網(wǎng)站建設(shè)公司成都創(chuàng)新互聯(lián)公司,蒙山網(wǎng)站設(shè)計制作，有大型網(wǎng)站制作公司豐富經(jīng)驗。已為蒙山近1000家提供企業(yè)網(wǎng)站建設(shè)服務(wù)。企業(yè)網(wǎng)站搭建\外貿(mào)營銷網(wǎng)站建設(shè)要多少錢，請找那個售后服務(wù)好的蒙山做網(wǎng)站的公司定做！

        git是現(xiàn)在市面上最流行的版本控制工具，書寫良好的commit message能大大提高代碼維護(hù)的效率。但是在日常開發(fā)中由于缺少對于commit message的約束，導(dǎo)致填寫內(nèi)容隨意、質(zhì)量參差不齊，可讀性低亦難以維護(hù)。在項目中引入commit message規(guī)范已是迫在眉睫。

一、市場主流規(guī)范

        現(xiàn)在市面上比較流行的方案是約定式提交規(guī)范（Conventional Commits），它受到了Angular提交準(zhǔn)則的啟發(fā)，并在很大程度上以其為依據(jù)。約定式提交規(guī)范是一種基于提交消息的輕量級約定。它提供了一組用于創(chuàng)建清晰的提交歷史的簡單規(guī)則；這使得編寫基于規(guī)范的自動化工具變得更容易。這個約定與SemVer相吻合，在提交信息中描述新特性、bug 修復(fù)和破壞性變更。它的 message 格式如下:

二、git commit 規(guī)范化工具 —— commitizen

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

        commitizen是一個撰寫合格commit message的工具，用于代替git commit 指令，而cz-conventional-changelog適配器提供conventional-changelog標(biāo)準(zhǔn)（約定式提交標(biāo)準(zhǔn)）。基于不同需求，也可以使用不同適配器。

        安裝完畢后，可直接使用git cz來取代git commit。
        全局模式下，需要 ~/.czrc 配置文件, 為commitizen指定Adapter。                   

2. 項目內(nèi)安裝commitlint & husky

        commitlint負(fù)責(zé)用于對commit message進(jìn)行格式校驗，husky負(fù)責(zé)提供更易用的git hook。

        commitlint只能做格式規(guī)范，無法觸及內(nèi)容。對于內(nèi)容質(zhì)量的把控只能靠我們自己。             

3. 添加相應(yīng)配置

        創(chuàng)建commitlint.config.js

        引入 husky

4. 使用

        執(zhí)行g(shù)it cz進(jìn)入interactive模式，根據(jù)提示依次填寫

        生成的commit message格式如下：

        填寫完畢后，husky會調(diào)用commitlint對message進(jìn)行格式校驗，默認(rèn)規(guī)定type及subject為必填項。

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

三、Commit message規(guī)范在rrd-fe落地使用

1. type

        type為必填項，用于指定commit的類型，約定了feat、fix兩個主要type，以及docs、style、build、refactor、revert五個特殊type，其余type暫不使用。

        當(dāng)一次改動包括主要type與特殊type時，統(tǒng)一采用主要type。

2. scope

        scope也為必填項，用于描述改動的范圍，格式為項目名/模塊名，例如：node-pc/commonrrd-h6/activity，而we-sdk不需指定模塊名。如果一次commit修改多個模塊，建議拆分成多次commit，以便更好追蹤和維護(hù)。

3. body

        body填寫詳細(xì)描述，主要描述改動之前的情況及修改動機(jī)，對于小的修改不作要求，但是重大需求、更新等必須添加body來作說明。

4. break changes

        break changes指明是否產(chǎn)生了破壞性修改，涉及break changes的改動必須指明該項，類似版本升級、接口參數(shù)減少、接口刪除、遷移等。

5. affect issues

        affect issues指明是否影響了某個問題。例如我們使用jira時，我們在commit message中可以填寫其影響的JIRA_ID，若要開啟該功能需要先打通jira與gitlab。參考文檔： User Docs | GitLab

        填寫方式例如：

四、示例

1、完整的commit message示例

2、相應(yīng)的git log

到此，相信大家對“Git提交規(guī)范的方法有哪些”有了更深的了解，不妨來實際操作一番吧！這里是創(chuàng)新互聯(lián)網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！