首頁  >  文章  >  Java  >  Java Git Commit Message使用規格是什麼

Java Git Commit Message使用規格是什麼

WBOY
WBOY轉載
2023-05-11 09:46:051546瀏覽

    一、Commit message 的格式

    每次提交,Commit message 都包含三個部分:Header,Body 和 Footer。

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

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

    1.1 Header

    Header部分只有一行,包含三個欄位: type(必要)、scope(必備)和subject(必要)。
    (1)type
    type用來說明 commit 的類別,只允許使用下面7個標識。

    • feat:新功能(feature)

    • fix:修補bug

    • docs:文件(documentation)

    • #style: 格式(不影響程式碼運行的變動)

    • refactor:重構(即不是新增功能,也不是修改bug的程式碼變動)

    • ##test:增加測試

    • build:建置流程或輔助工具的變動

    • ##(2 )scope
    scope用來說明commit 影響的範圍,例如指標模板、規則上下線等等,視項目不同而不同。

    (3)subject
    subject是 commit 目的的簡短描述,不超過50個字元。

      1. 以動詞開頭,使用第一人稱現在時,例如change,而不是changed或changes
    • 2. 第一個字母小寫
    • 3. 結尾不加句點(.)
    • 1.2 Body

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

      1. 需要簡單的列出各種正向或反向的測試場景,測試通過,填pass。
    • 2. 增加修改人資訊
    • #二、範例

    2.1 feat範例



    feat(規則上線、建置、生效、模擬生效): 新增規則上底線功能 

    1. 規則上下線主流程,引擎正常訂閱,fldl產生正常。 passJava Git Commit Message使用規格是什麼2. 規則上下線,傳入不存在的規則編號,異常提示。 pass

    提交人:xxx

    Java Git Commit Message使用規格是什麼2.2 fix範例

    Java Git Commit Message使用規格是什麼#fix(模型模組): 模型測試失敗

    ###1. 導入mar模型,包含衍生字段。 pass###2. 導入mar模型,不包含衍生欄位。 pass######提交人:xxx#########外掛推薦######idea可以安裝程式碼提交規範的外掛程式。 ######1.安裝外掛程式############### 2.提交時選擇外掛程式提交################## ###

    以上是Java Git Commit Message使用規格是什麼的詳細內容。更多資訊請關注PHP中文網其他相關文章!

    陳述:
    本文轉載於:yisu.com。如有侵權,請聯絡admin@php.cn刪除