git commit 提交規范


更多文章

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

大致分為三個部分(使用空行分割):

  1. 標題行: 必填, 描述主要修改類型和內容
  2. 主題內容: 描述為什么修改, 做了什么樣的修改, 以及開發的思路等等
  3. 頁腳注釋: 放 Breaking Changes 或 Closed Issues

type: commit 的類型

  • init: 初始化
  • feat: 新特性
  • fix: 修改問題
  • refactor: 代碼重構
  • docs: 文檔修改
  • style: 代碼格式修改, 注意不是 css 修改
  • test: 測試用例修改
  • build: 構建項目
  • chore: 其他修改, 比如依賴管理
  • scope: commit 影響的范圍, 比如: route, component, utils, build...
  • subject: commit 的概述

body: commit 具體修改內容, 可以分為多行.

示例

fix(修復BUG)

如果修復的這個BUG只影響當前修改的文件,可不加范圍。如果影響的范圍比較大,要加上范圍描述。

例如這次 BUG 修復影響到全局,可以加個 global。如果影響的是某個目錄或某個功能,可以加上該目錄的路徑,或者對應的功能名稱。

// 示例1
fix(global):修復checkbox不能復選的問題
// 示例2 下面圓括號里的 common 為通用管理的名稱
fix(common): 修復字體過小的BUG,將通用管理下所有頁面的默認字體大小修改為 14px
// 示例3
fix: value.length -> values.length

feat(添加新功能或新頁面)

feat: 添加網站主頁靜態頁面

這是一個示例,假設對頁面內容進行了一些描述。
 
這里是備注,可以是放BUG鏈接或者一些重要性的東西。

chore(其他修改)

chore 的中文翻譯為日常事務、例行工作,顧名思義,即不在其他 commit 類型中的修改,都可以用 chore 表示。

chore: 將表格中的查看詳情改為詳情

其他類型的 commit 和上面三個示例差不多,在此不再敘述。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM