成人免费xxxxx在线视频软件_久久精品久久久_亚洲国产精品久久久_天天色天天色_亚洲人成一区_欧美一级欧美三级在线观看

程序員如何通過插件規范 Git commit message 的提交?

開發 前端
有很多小伙伴就要問了,寫那么詳細有什么用?規范我們的提交記錄,主要是為了能追溯代碼歷史,很多時候我們自己寫的代碼在時間長了以后都記不住,更不要說別人寫的代碼了,所以只能從流程和規范上面來幫助大家更好的記憶。

Git 相信大家在日常的工作中經常會使用到,在我們完成一個需求開發或者 bug 修復的時候都會將變動的代碼文件進行 commit 提交到遠程。

那么問題來了,仔細看下你的提交記錄,里面是不是有很多 test ,fix,update,add 等等絲毫看不出任何含義的 commit message。

commit message 的提交很多時候都只依賴開發人員的自我規范,而開發人員往往在需求緊急或者 bug 要及時修復的時候,根本不會花很多時間在寫 git commit message 的信息。而且就算是寫,每個人的風格也不一樣,所以寫出來的 message 也不完全相同。

這個時候我們就需要有一套規范了,現在業界比較常用的規范是的格式是這樣的:type(scope):subject,下面我們詳細來聊一下。

Type

type 代表的是提交內容的一種類型,每一種類型都代表著不同的含義,具體的類型取值和含義如下:

  1. feat:表示開發一個新的需求特性;
  2. fix:表示修復一個 bug;
  3. docs:表示是針對文檔的修改,并沒有修改代碼;
  4. style:格式修改,不影響代碼功能;
  5. refactor:不是進行 feat 和 fix 的代碼修改,重構功能;
  6. perf:提升性能的代碼修改;
  7. test:添加測試代碼或者修正已經存在的測試功能代碼;
  8. build:修改會影響構建或者依賴的代碼;
  9. ci:修改集成配置的文件或者腳本;
  10. chore:一些不夠影響到源碼和測試文件的修改;
  11. revert:針對之前的一個提交的 revert 修改;

對于我們來說在寫一個 git commit 的時候,要搞清楚當前提交的內容的真正含義是什么,從而選擇正確的類型。此外還要求我們對于代碼的修改需要盡量細粒度,話句話說就是盡量將一個大的改動進行拆分,根據適當的情況進行 git 提交,避免一次性提交太多的改動。

Scope

scope 表示的當次 git 提交的內容影響的范圍,這個范圍比較寬泛,比如可以是 DAO 層,Controller 層,或者是具有特定功能的比如 utils 工具模塊,權限模塊,數據模塊等等,只要能跟自己的項目掛上鉤,表達出修改的范圍就行,如果涉及到的范圍比較多的話,可以用 * 表示,并不強制要求。

Subject

subject 部分是最重要的 git commit message 的部分,也就是我們經常要寫提交信息的部分,這一部分通常會一個言簡意賅的信息描述,需要寫出我們改動代碼的原因。

上面的 type,scope,subject 三個部分是我們常用的部分,不過有些規范將 git 的提交規范定義為 Header,Body 和 Footer 三個部分,而 type,scope,subject 三個屬于 Header 的部分。

擴展

Header 部分也就是上面提到的三個部分,是每個 git 提交的基礎內容;Body 部分則是更加詳細的描述信息,用于完整記錄代碼的修改地方和邏輯;Footer 部分則會將本次提交的內容與具體的需求或者缺陷相關聯,比如對應的需求地址是什么,或者修復的 Bug 缺陷是什么等。

IDEA 插件

上面的內容不多,但是要記下來的還是很繁瑣的,特別是有時候我們很難記住所有的 type 類型,好在 IDEA 現在有一個插件,就是用來規范 git 提交模板的。

在 IDEA 的插件市場中安裝 git commit template,直接搜索安裝,然后重啟 IDEA 即可。

圖片圖片

安裝完成過后,在我們需求提交代碼的時候,會出現這個按鈕。

圖片圖片

點擊一下就可以看到下面這個頁面,其中 short description 就是我們上面提到的 subject,而 Long description 代表的就是 Body 部分,而下面的 Breaking changes 和 Closed issues 則代表的是 Footer 部分,在使用的過程中按需填入即可。

圖片圖片

總結

有很多小伙伴就要問了,寫那么詳細有什么用?規范我們的提交記錄,主要是為了能追溯代碼歷史,很多時候我們自己寫的代碼在時間長了以后都記不住,更不要說別人寫的代碼了,所以只能從流程和規范上面來幫助大家更好的記憶。

責任編輯:武曉燕 來源: Java極客技術
相關推薦

2020-08-14 08:00:39

Git數據層控制層

2023-03-27 08:03:26

Git代碼控制層

2021-03-02 18:37:18

commit程序員公司

2020-05-12 14:57:06

git commit代碼前端

2010-03-22 09:32:42

自學編程

2025-05-19 00:00:00

Git代碼自動化

2013-08-20 09:33:59

程序員

2021-12-20 07:31:19

Java ElasticSea搜索

2020-03-02 15:15:37

程序員工資協議

2014-12-01 10:05:25

程序員

2014-07-14 11:28:41

2015-07-02 11:20:17

程序員代碼

2023-10-12 18:00:34

Git系統命令

2011-05-13 14:34:02

程序員

2009-07-01 11:08:21

Firefox插件推薦

2020-02-25 22:41:41

程序員技能開發者

2018-07-10 10:45:00

規范Commit項目

2023-10-23 08:09:34

Chrome插件擴展

2016-04-28 11:17:33

互動出版網

2018-07-10 11:05:18

開發者技能命令
點贊
收藏

51CTO技術棧公眾號

主站蜘蛛池模板: 亚洲精品综合一区二区 | 亚洲综合一区二区三区 | caoporn国产| 国产一区视频在线 | 欧美一区二区三区日韩 | 手机av在线 | 日韩中文字幕在线观看 | 亚洲精彩视频在线观看 | 亚洲欧美综合精品久久成人 | 中文字幕在线观看一区 | 精品久久99 | 99国产视频 | 国产成人jvid在线播放 | 三级在线视频 | 免费观看成人av | 久久久久久久久久久久亚洲 | 日本高清视频在线播放 | 日韩在线精品强乱中文字幕 | 久久久久无码国产精品一区 | 久久久成人免费一区二区 | 精品一区精品二区 | 成年人免费网站 | 午夜国产一级片 | 亚洲国产中文字幕 | 午夜视频一区 | 国产亚洲一区二区在线观看 | 999久久久 | 伊人婷婷 | 9久久婷婷国产综合精品性色 | 国产在线拍偷自揄拍视频 | 亚洲一区中文字幕 | 国产精品99久久久久久人 | 国产精品久久性 | 欧美成人一区二区三区 | 91精品国产综合久久久久久蜜臀 | 一区二区免费在线观看 | www亚洲成人 | 国产日批| 亚洲精品中文字幕中文字幕 | www.嫩草| 日韩欧美国产一区二区三区 |