如何寫Commit記錄

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

莊浪網(wǎng)站制作公司哪家好，找創(chuàng)新互聯(lián)！從網(wǎng)頁設(shè)計、網(wǎng)站建設(shè)、微信開發(fā)、APP開發(fā)、成都響應(yīng)式網(wǎng)站建設(shè)公司等網(wǎng)站項目制作，到程序開發(fā)，運(yùn)營維護(hù)。創(chuàng)新互聯(lián)于2013年開始到現(xiàn)在10年的時間，我們擁有了豐富的建站經(jīng)驗和運(yùn)維經(jīng)驗，來保證我們的工作的順利進(jìn)行。專注于網(wǎng)站建設(shè)就選創(chuàng)新互聯(lián)。

安裝插件

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

如何寫Commit記錄

正常從IDEA提交代碼的時候。我們發(fā)現(xiàn)多了一個小按鈕。

如何寫Commit記錄

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

如何寫Commit記錄

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

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

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

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

提交類型Type

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

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

除了這些預(yù)設(shè)的，團(tuán)隊還可以按照自己的需求，增加新的type。比如專門處理線上工單，就可以創(chuàng)造一個叫做ticket的類型。

范圍scope

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

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

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

其他

主題subject

這個體現(xiàn)的是總結(jié)概括能力，沒得跑。一句話能夠說明主要的提交是什么。subject也是眾多git管理工具默認(rèn)顯示的一行。如果你寫的標(biāo)準(zhǔn)，那么提交記錄看起來就很漂亮很規(guī)整。

正文Body

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

尾部Footer

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

這部分自定義行也是比較強(qiáng)的。

Skip CI

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

End

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

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

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

有了這些基礎(chǔ)，從commit log，自動生成change log，就變的非常的容易。配合持續(xù)集成平臺，自動生成發(fā)版的變更記錄，也是可行的，這也是為什么團(tuán)隊管理，都在一直強(qiáng)調(diào)git的提交規(guī)范。因為它確實非常有用。

到此，相信大家對“如何寫Commit記錄”有了更深的了解，不妨來實際操作一番吧！這里是創(chuàng)新互聯(lián)網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！

當(dāng)前題目：如何寫Commit記錄
文章轉(zhuǎn)載：http://jinyejixie.com/article10/pshcdo.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供、移動網(wǎng)站建設(shè)、用戶體驗、建站公司、響應(yīng)式網(wǎng)站、動態(tài)網(wǎng)站

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時需注明來源：創(chuàng)新互聯(lián)

猜你還喜歡下面的內(nèi)容

成人午夜视频全免费观看高清-秋霞福利视频一区二区三区-国产精品久久久久电影小说-亚洲不卡区三一区三区一区

如何寫Commit記錄