如何寫Commit記錄

發布時間：2021-10-18 13:34:27 來源：億速云閱讀：239 作者：iii 欄目：web開發

本篇內容主要講解“如何寫Commit記錄”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學習“如何寫Commit記錄”吧!

安裝插件

在IDEA的Marketplace中，搜索Git Commit Template，就可以安裝這個插件。插件很小，很快就能下載下來。

如何寫Commit記錄

正常從IDEA提交代碼的時候。我們發現多了一個小按鈕。

如何寫Commit記錄

點擊之后，將彈出一個窗口。讓你去設計提交模板。

如何寫Commit記錄

這么多信息，真的讓人頭暈。怪不得程序員們都不喜歡寫提交記錄。

其實，在插件的安裝界面，就已經說明了這個提交記錄的格式。

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

從描述中，可以肯容易的看到一個提交記錄中，應該包含哪些東西。其中類型最多的，當然是提交類型。

提交類型Type

我們按照插件顯示的順序來說明一下。

feat 功能feature的意思，也是最常用的。當你的功能有變更的時候，都可以采用這種類型的type
fix 當然指的是bug修復
docs 更新了文檔，或者更新了注釋
style 代碼格式調整，比如執行了format、更改了tab顯示等
refactor 重構代碼。指的是代碼結構的調整，比如使用了一些設計模式重新組織了代碼
perf 對項目或者模塊進行了性能優化。比如一些jvm的參數改動，把stringbuffer改為stringbuilder等
test 這個簡單，就是增加了單元測試和自動化相關的代碼
build 影響編譯的一些更改，比如更改了maven插件、增加了npm的過程等
ci 持續集成方面的更改。現在有些build系統喜歡把ci功能使用yml描述。如有這種更改，建議使用ci
chore 其他改動。比如一些注釋修改或者文件清理。不影響src和test代碼文件的，都可以放在這里
revert 回滾了一些前面的代碼

除了這些預設的，團隊還可以按照自己的需求，增加新的type。比如專門處理線上工單，就可以創造一個叫做ticket的類型。

范圍scope

scope是范圍的意思，主要指的是代碼的影響面。scope并沒有要求強制，但團隊可以按照自己的理解進行設計。通常由技術維度和業務維度兩種劃分方式。比如按照技術分為：controller、dto、service、dao等。但因為一個功能提交，會涉及到多個scope(都不喜歡非常細粒度的提交)，所以按照技術維度分的情況比較少。

按照業務模塊進行劃分，也是比較不錯的選擇。比如分為user、order等劃分，可以很容易看出是影響用戶模塊還是order模塊。

如果你實在不知道怎么填，那就留空。

其他

主題subject

這個體現的是總結概括能力，沒得跑。一句話能夠說明主要的提交是什么。subject也是眾多git管理工具默認顯示的一行。如果你寫的標準，那么提交記錄看起來就很漂亮很規整。

正文Body

主要填寫詳細的改動記錄。我一般習慣列上1234，但如果你的subject寫的非常好，正文可以直接弱化。但如果時間充裕，填寫上重要記錄的前因后果，需求背景，是一個好的習慣。

尾部Footer

添加一些額外的hook，比如提交記錄之后，自動關閉jira的工單(JIRA和gitlab等是可以聯動的)。在比如觸發一些文檔編譯或者其他動作。

這部分自定義行也是比較強的。

Skip CI

最后還有一個skip CI選項。一般的ci工具，都可以設置提交代碼時自動觸發編譯。但你可以告訴它忽略本次提交。這可能是因為你提前預判到了一些構建風險，或者就是不想編譯。

End

最后，看一個典型的提交記錄，有了工具的支持，我們的瞎扯也看得正經起來。

fix(order): 修復了1分錢買汽車的bug  商務反饋可以1分錢買汽車，目前已經賣出了100w量  Closes #2455  [skip ci]

其實，提交的核心是type和subject。一個用來表示它的提交類型，一個用來對提交進行概括性總結，寫好了這兩點，就能輕輕松松秒殺80%的程序員了。

有了這些基礎，從commit log，自動生成change log，就變的非常的容易。配合持續集成平臺，自動生成發版的變更記錄，也是可行的，這也是為什么團隊管理，都在一直強調git的提交規范。因為它確實非常有用。

到此，相信大家對“如何寫Commit記錄”有了更深的了解，不妨來實際操作一番吧！這里是億速云網站，更多相關內容可以進入相關頻道進行查詢，關注我們，繼續學習！

向AI問一下細節

中文字幕av专区_日韩电影在线播放_精品国产精品久久一区免费式_av在线免费观看网站

如何寫Commit記錄

猜你喜歡

中文字幕av专区_日韩电影在线播放_精品国产精品久久一区免费式_av在线免费观看网站

如何寫Commit記錄

猜你喜歡

最新資訊

相關推薦

相關標簽