<mark id="10v55"></mark>
<small id="10v55"><video id="10v55"></video></small>

  • <tr id="10v55"></tr>
    <menuitem id="10v55"></menuitem>

    MorJS Git Commit 約定式提交規范

    2024-01-24 09:45 更新

    本文中的關鍵詞 “必須(MUST)”、“禁止(MUST NOT)”、“必要(REQUIRED)”、“應當(SHALL)”、“不應當(SHALL NOT)”、“應該(SHOULD)”、“不應該(SHOULD NOT)”、“推薦(RECOMMENDED)”、“可以(MAY)” 和 “可選(OPTIONAL)” ,其相關解釋參考 RFC 2119 。

    1. 每個提交都必須使用類型字段前綴,它由一個名詞構成,諸如 featfix ,其后接可選的范圍字段,可選的 !,以及必要的冒號(英文半角)和空格。
    2. 當一個提交為應用或類庫實現了新功能時,必須使用 feat 類型。
    3. 當一個提交為應用修復了 bug 時,必須使用 fix 類型。
    4. 范圍字段可以跟隨在類型字段后面。范圍必須是一個描述某部分代碼的名詞,并用圓括號包圍,例如: fix(parser):
    5. 描述字段必須直接跟在 <類型>(范圍) 前綴的冒號和空格之后。描述指的是對代碼變更的簡短總結,例如: fix: array parsing issue when multiple spaces were contained in string 。
    6. 在簡短描述之后,可以編寫較長的提交正文,為代碼變更提供額外的上下文信息。正文必須起始于描述字段結束的一個空行后。
    7. 提交的正文內容自由編寫,并可以使用空行分隔不同段落。
    8. 在正文結束的一個空行之后,可以編寫一行或多行腳注。每行腳注都必須包含一個令牌(token),后面緊跟 :<space><space># 作為分隔符,后面再緊跟令牌的值(受 git trailer convention 啟發)。
    9. 腳注的令牌必須使用 - 作為連字符,比如 Acked-by (這樣有助于區分腳注和多行正文)。有一種例外情況就是 BREAKING CHANGE,它可以被認為是一個令牌。
    10. 腳注的值可以包含空格和換行,值的解析過程必須直到下一個腳注的令牌/分隔符出現為止。
    11. 破壞性變更必須在提交信息中標記出來,要么在 <類型>(范圍) 前綴中標記,要么作為腳注的一項。
    12. 包含在腳注中時,破壞性變更必須包含大寫的文本 BREAKING CHANGE,后面緊跟著冒號、空格,然后是描述,例如:BREAKING CHANGE: environment variables now take precedence over config files 。
    13. 包含在 <類型>(范圍) 前綴時,破壞性變更必須通過把 ! 直接放在 : 前面標記出來。如果使用了 !,那么腳注中可以不寫 BREAKING CHANGE:,同時提交信息的描述中應該用來描述破壞性變更。
    14. 在提交說明中,可以使用 featfix 之外的類型,比如:docs: updated ref docs. 。
    15. 工具的實現必須不區分大小寫地解析構成約定式提交的信息單元,只有 BREAKING CHANGE 必須是大寫的。
    16. BREAKING-CHANGE 作為腳注的令牌時必須是 BREAKING CHANGE 的同義詞。
    以上內容是否對您有幫助:
    在線筆記
    App下載
    App下載

    掃描二維碼

    下載編程獅App

    公眾號
    微信公眾號

    編程獅公眾號

    √天堂资源中文最新版,√天堂资源最新版在线,女人脱了内裤露P毛A片