如何規(guī)范提交Git

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

讓客戶滿意是我們工作的目標(biāo)，不斷超越客戶的期望值來自于我們對這個行業(yè)的熱愛。我們立志把好的技術(shù)通過有效、簡單的方式提供給客戶，將通過不懈努力成為客戶在信息化領(lǐng)域值得信任、有價(jià)值的長期合作伙伴，公司提供的服務(wù)項(xiàng)目有：主機(jī)域名、雅安服務(wù)器托管、營銷軟件、網(wǎng)站建設(shè)、新沂網(wǎng)站維護(hù)、網(wǎng)站推廣。

1. 前言

目前大部分公司都在使用Git作為版本控制，每個程序員每天都要進(jìn)行代碼的提交。很多開發(fā)者也包括我自己，有時(shí)候趕時(shí)間或者圖省事，就這么提交：

git commit -m "修改bug,優(yōu)化代碼"

過了一段，突然去查找一個具體的提交你會發(fā)現(xiàn)不是特別好找。因此我們需要規(guī)范我們的代碼提交來避免這種情況。同時(shí)良好的提交規(guī)范也有助于我們生成清晰的ChangeLog，更利于同事之間的協(xié)作。

如果你想成為知名開源項(xiàng)目的貢獻(xiàn)者更要規(guī)范自己的代碼提交。

2. Git提交規(guī)范

目前業(yè)內(nèi)做的比較好的，比較具有參考價(jià)值的就是知名前端框架AngularJS的提交規(guī)范。我們先來看一個例子：

對應(yīng)的格式：

<type>[optional scope]: <description>
# 空行
[optional body]
# 空行
[optional footer]

更嚴(yán)格的項(xiàng)目可能提交要求使用英文描述，特別是國際化的開源項(xiàng)目。

根據(jù)上面這個例子我們來了解一下這個業(yè)界比較認(rèn)可的Git提交規(guī)范。

type

refactor 表示本次提交的是重構(gòu)代碼，也就是它是一個提交的類型type，除了refactor還有：

• feat 新功能，顧名思義就是新需求的實(shí)現(xiàn)。

• fix 修復(fù)，就是對bug的修復(fù)。

• docs 文檔，主要用來描述文檔的變更。

• style 主要是代碼風(fēng)格相關(guān)的提交，比如格式化等。

• refactor 重構(gòu)代碼，對已有功能的重構(gòu)，但是區(qū)別于bugfix。

• test 測試相關(guān)的提交，不太常用。

• chore 構(gòu)建過程或輔助工具的變動，不太常用，比如之前用Maven，后面換成了Gradle。

每次提交聲明提交的type是必須的，它讓本次提交的作用一目了然。

scope（可選）

用來表明本次提交影響的范圍，方便快速定位。你可以寫明影響的是哪個模塊（通常是模塊名稱）或者是哪個層（數(shù)據(jù)層、服務(wù)層、還是視圖層）。

subject

就是上面的修改版權(quán)信息，是對本次提交的簡短描述概括。就像胖哥寫文章要起一個標(biāo)題一樣，不要過長。

body（可選）

就是比較詳細(xì)描述本次提交涉及的條目，羅列代碼功能，這里胖哥習(xí)慣用markdown的列表語法，也就是用中劃線換行隔開條目。當(dāng)然body不是必選的，如果subject能夠描述清楚的話。

foot（可選）

描述與本次提交相關(guān)聯(lián)的break change或issue。

break change

指明本次提交是否產(chǎn)生了破壞性修改，類似版本升級、接口參數(shù)減少、接口刪除、遷移等。如果產(chǎn)生了上述的影響強(qiáng)烈建議在提交信息中寫明break change，有利于出問題時(shí)快速定位，回滾，復(fù)盤。

issue

如果發(fā)現(xiàn)項(xiàng)目有bug、或者有優(yōu)化的建議、甚至新增一個任務(wù)，就可以利用issue給項(xiàng)目提交一個任務(wù)。

issue不是一些Git平臺的專屬功能，JIRA等平臺也有類似功能，它們的作用大同小異，都可以很好地反應(yīng)項(xiàng)目的成長狀況和參與度。那么在Git提交時(shí)，我們可以在foot區(qū)域關(guān)聯(lián)本次提交涉及的issue。

# 涉及
issues  #F12YC,#F45JW
# 關(guān)閉
Closes #F12YC

這里沒有固定格式，不過盡量去參考一些知名項(xiàng)目去做。

3. 工具安利

說了這么多，相信你已經(jīng)對Git提交的規(guī)范有所了解了。這里推薦一些有用的工具來幫助你將這些規(guī)范落實(shí)到位。在Intellij IDEA的插件市場有很多Git Commit Message模板插件，可以可視化的實(shí)現(xiàn)這些規(guī)范。

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

網(wǎng)站欄目：如何規(guī)范提交Git
網(wǎng)站URL：http://bm7419.com/article28/gocdcp.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供網(wǎng)站設(shè)計(jì)公司、品牌網(wǎng)站制作、標(biāo)簽優(yōu)化、微信小程序、域名注冊、云服務(wù)器

廣告

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