Java?Git?Commit?Message使用規(guī)范
概述
不知道大家在各自項目中是如何寫提供代碼的commit message, 我們項目有的同事寫的很簡單，壓根不知道提交了什么內(nèi)容，是新功能還是缺陷修復(fù)。本質(zhì)上 commit message就是為了讓團(tuán)隊成員知道這次提交的內(nèi)容，為此，我們出了一個規(guī)范，約定團(tuán)隊的每個同事按照這個規(guī)范提交代碼，達(dá)到通過message能夠了解此次修改的內(nèi)容。
一、Commit message 的格式
每次提交，Commit message 都包括三個部分：Header，Body 和 Footer。
<type>(<scope>): <subject> // 空一行 <body>
其中，Header、針對feat和fix類型的提交內(nèi)容 Body 是必需的。 不管是哪一個部分，任何一行都不得超過72個字符（或100個字符）。這是為了避免自動換行影響美觀。
1.1 Header
Header部分只有一行，包括三個字段： type（必需）、scope（必需）和subject（必需）。
（1）type
type用于說明 commit 的類別，只允許使用下面7個標(biāo)識。
- feat：新功能（feature）
- fix：修補(bǔ)bug
- docs：文檔（documentation）
- style： 格式（不影響代碼運(yùn)行的變動）
- refactor：重構(gòu)（即不是新增功能，也不是修改bug的代碼變動）
- test：增加測試
- build：構(gòu)建過程或輔助工具的變動
（2）scope
scope用于說明 commit 影響的范圍，比如指標(biāo)模板、規(guī)則上下線等等，視項目不同而不同。
（3）subject
subject是 commit 目的的簡短描述，不超過50個字符。
- 1. 以動詞開頭，使用第一人稱現(xiàn)在時，比如change，而不是changed或changes
- 2. 第一個字母小寫
- 3. 結(jié)尾不加句號（.）
1.2 Body
Body 部分是對本次 commit 的詳細(xì)描述，可以分成多行。
- 1. 需要簡要的列出各種正向或者反向的測試場景，測試通過，填pass。
- 2. 增加修改人信息
二、例子
2.1 feat例子
feat(規(guī)則上下線、構(gòu)建、生效、仿真生效): 添加規(guī)則上下線功能
1. 規(guī)則上下線主流程，引擎正常訂閱，fldl生成正常。 pass
2. 規(guī)則上下線，傳入不存在的規(guī)則編號，異常提示。 pass提交人：xxx
2.2 fix例子
fix(模型模塊): 模型測試失敗
1. 導(dǎo)入mar模型，包含衍生字段。 pass
2. 導(dǎo)入mar模型，不包含衍生字段。 pass提交人：xxx
插件推薦
idea可以安裝代碼提交規(guī)范的插件。
1.安裝插件
2.提交時選擇插件提交
到此這篇關(guān)于Java Git Commit Message使用規(guī)范的文章就介紹到這了,更多相關(guān)Java Git Commit Message內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要為大家介紹了Seata?AT模式TM處理流程圖文示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-09-09
這篇文章主要介紹了Springboot傳參的相關(guān)知識,本文通過實例代碼給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友參考下吧2023-11-11
mybatis配置Mapper.xml文件時遇到的問題及解決
這篇文章主要介紹了mybatis配置Mapper.xml文件時遇到的問題及解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-01-01
這篇文章主要介紹了java時間格式的簡單整理，文中通過示例介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友可以參考一下2019-06-06
這篇文章主要為大家詳細(xì)介紹了23種設(shè)計模式之java備忘錄模式，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-01-01
Hadoop是一個由Apache基金會所開發(fā)的分布式系統(tǒng)基礎(chǔ)架構(gòu)。 用戶可以在不了解分布式底層細(xì)節(jié)的情況下，開發(fā)分布式程序。充分利用集群的威力進(jìn)行高速運(yùn)算和存儲2017-09-09
SpringMVC結(jié)合天氣api實現(xiàn)天氣查詢
這篇文章主要為大家詳細(xì)介紹了SpringMVC結(jié)合天氣api實現(xiàn)天氣查詢，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-05-05
這篇文章主要介紹了Spring在代碼中獲取bean的幾種方式詳解,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-08-08
新手如果在web項目創(chuàng)建后WEB-INF下面沒有出現(xiàn)web.xml，怎么辦？別慌，沒有web.xml文件的原因是因為在創(chuàng)建web項目的時候沒有把創(chuàng)建web.xml勾上。這篇文章主要介紹了web項目WEB-INF下沒有web.xml的解決方法,需要的朋友可以參考下2022-12-12
全面解析Spring Security 過濾器鏈的機(jī)制和特性
這篇文章主要介紹了Spring Security 過濾器鏈的機(jī)制和特性,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-07-07