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 具體修改內容, 可以分爲多行.

footer: 一些備註, 通常是 BREAKING CHANGE 或修復的 bug 的鏈接.

示例

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 和上面三個示例差不多,在此不再敘述。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章