溫馨提示×

溫馨提示×

您好，登錄后才能下訂單哦！

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務(wù)條款》

Java?Git?Commit?Message使用規(guī)范是什么

發(fā)布時間：2022-08-29 11:53:22 來源：億速云 閱讀：147 作者：iii 欄目：開發(fā)技術(shù)

這篇“Java Git Commit Message使用規(guī)范是什么”文章的知識點大部分人都不太理解，所以小編給大家總結(jié)了以下內(nèi)容，內(nèi)容詳細，步驟清晰，具有一定的借鑒價值，希望大家閱讀完這篇文章能有所收獲，下面我們一起來看看這篇“Java Git Commit Message使用規(guī)范是什么”文章吧。

    一、Commit message 的格式

    每次提交，Commit message 都包括三個部分：Header，Body 和 Footer。

    <type>(<scope>): <subject>
// 空一行
<body>

    其中，Header、針對feat和fix類型的提交內(nèi)容 Body 是必需的。 不管是哪一個部分，任何一行都不得超過72個字符（或100個字符）。這是為了避免自動換行影響美觀。

    1.1 Header

    Header部分只有一行，包括三個字段： type（必需）、scope（必需）和subject（必需）。
    （1）type
    type用于說明 commit 的類別，只允許使用下面7個標(biāo)識。

    • feat：新功能（feature）

    • fix：修補bug

    • docs：文檔（documentation）

    • style： 格式（不影響代碼運行的變動）

    • refactor：重構(gòu)（即不是新增功能，也不是修改bug的代碼變動）

    • test：增加測試

    • build：構(gòu)建過程或輔助工具的變動

    （2）scope
    scope用于說明 commit 影響的范圍，比如指標(biāo)模板、規(guī)則上下線等等，視項目不同而不同。
    （3）subject
    subject是 commit 目的的簡短描述，不超過50個字符。

    • 1. 以動詞開頭，使用第一人稱現(xiàn)在時，比如change，而不是changed或changes

    • 2. 第一個字母小寫

    • 3. 結(jié)尾不加句號（.）

    1.2 Body

    Body 部分是對本次 commit 的詳細描述，可以分成多行。

    • 1. 需要簡要的列出各種正向或者反向的測試場景，測試通過，填pass。

    • 2. 增加修改人信息

    二、例子

    2.1 feat例子

    feat(規(guī)則上下線、構(gòu)建、生效、仿真生效): 添加規(guī)則上下線功能 

    1. 規(guī)則上下線主流程，引擎正常訂閱，fldl生成正常。 pass
    2. 規(guī)則上下線，傳入不存在的規(guī)則編號，異常提示。 pass

    提交人：xxx

    2.2 fix例子

    fix(模型模塊): 模型測試失敗

    1. 導(dǎo)入mar模型，包含衍生字段。 pass
    2. 導(dǎo)入mar模型，不包含衍生字段。 pass

    提交人：xxx

    插件推薦

    idea可以安裝代碼提交規(guī)范的插件。

    1.安裝插件

    Java?Git?Commit?Message使用規(guī)范是什么

     2.提交時選擇插件提交

    Java?Git?Commit?Message使用規(guī)范是什么

    Java?Git?Commit?Message使用規(guī)范是什么

    以上就是關(guān)于“Java Git Commit Message使用規(guī)范是什么”這篇文章的內(nèi)容，相信大家都有了一定的了解，希望小編分享的內(nèi)容對大家有幫助，若想了解更多相關(guān)的知識內(nèi)容，請關(guān)注億速云行業(yè)資訊頻道。

    向AI問一下細節(jié)

    免責(zé)聲明：本站發(fā)布的內(nèi)容（圖片、視頻和文字）以原創(chuàng)、轉(zhuǎn)載和分享為主，文章觀點不代表本網(wǎng)站立場，如果涉及侵權(quán)請聯(lián)系站長郵箱：is@yisu.com進行舉報，并提供相關(guān)證據(jù)，一經(jīng)查實，將立刻刪除涉嫌侵權(quán)內(nèi)容。

    AI
    助
    手