Git提交規范

1、背景

在多人協作項目中,如果代碼風格統一、代碼提交信息的說明準確,那么在后期協作以及Bug處理時會更加方便。

因此,在本文章中,我會介紹怎么使用下面這個工具,在git push 代碼之前檢測commit messages:

commitlint
husky

2、先來介紹博主采用的commit規范

Commit message格式

<type>: <subject>

注意冒號后面有空格。
type

用于說明 commit 的類別,只允許使用下面7個標識。

Deat:新功能(feature)
Fix:修補bug
Docs:文檔(documentation)
Style: 格式(不影響代碼運行的變動)
Refactor:重構(即不是新增功能,也不是修改bug的代碼變動)
Test:增加測試
Chore:構建過程或輔助工具的變動

如果type為feat和fix,則該 commit 將肯定出現在 Change log 之中。
subject

subject是 commit 目的的簡短描述,不超過50個字符,且結尾不加句號(.)。

3. 使用工具校驗commit是否符合規范

3.1 全局安裝
3.2 生成配置配件

這個文件在根目錄下生成就可以了。

3.2 在commitlint.config.js制定提交message規范

上面我們就完成了commitlint的安裝與提交規范的制定。檢驗commit message的最佳方式是結合git hook,所以需要配合Husky

3.4 husky介紹


husky繼承了Git下所有的鉤子,在觸發鉤子的時候,husky可以阻止不合法的commit,push等等。注意使用husky之前,必須先將代碼放到git 倉庫中,否則本地沒有.git文件,就沒有地方去繼承鉤子了。

安裝成功后需要在項目下的package.json中配置

最后我們可以正常的git操作

git commit的時候會觸發commlint。下面演示下不符合規范提交示例:

上面message不符合提交規范,所以會提示錯誤。

我們修改下type

commit成功。

3.5 husky的鉤子

可以在package.json下面添加如下的鉤子。

4、最后總結過程中遇到一些問題

  1. git commit后可能報錯相關‘regenerator-runtime’模塊找不到;解決方式:npm install regenerator-runtime –save。
  2. git commit -m “messge”,用雙引號

[轉載自]https://blog.csdn.net/y491887095/article/details/80594043

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • git的規范和相關科普知識 git commit 的規范要求(參考Angular團隊) message格式如下: ...
    達文西_Huong閱讀 779評論 0 0
  • 目的 commit message應該清晰明了,說明本次提交的目的 commit message格式 type(必...
    IT小妞兒閱讀 2,927評論 0 2
  • git是現在市面上最流行的版本控制工具,書寫良好的commit message能大大提高代碼維護的效率。但是在日常...
    涅槃快樂是金閱讀 2,781評論 0 12
  • 來源:別亂提交代碼了,看下大廠 Git 提交規范是怎么做的! - 芋道源碼的文章 - 知乎 1.全局安裝commi...
    黃同學2019閱讀 498評論 0 0
  • Git 規范Git 作為現在最流行的分布式管理工具,基本上是每個團隊的必備。 Git Commit格式校驗準備co...
    天明丶胡金斌閱讀 312評論 0 0