快捷導(dǎo)航

Java?Git?Commit?Message使用規(guī)范

更新時(shí)間：2022年08月28日 08:27:09 作者：JAVA旭陽???????

這篇文章主要介紹了Java?Git?Commit?Message使用規(guī)范，文章圍繞主題展開詳細(xì)的內(nèi)容介紹，具有一定的參考價(jià)值，感興趣的小伙伴可以參考一下，希望對你的學(xué)習(xí)有所幫助

概述

不知道大家在各自項(xiàng)目中是如何寫提供代碼的commit message, 我們項(xiàng)目有的同事寫的很簡單，壓根不知道提交了什么內(nèi)容，是新功能還是缺陷修復(fù)。本質(zhì)上 commit message就是為了讓團(tuán)隊(duì)成員知道這次提交的內(nèi)容，為此，我們出了一個(gè)規(guī)范，約定團(tuán)隊(duì)的每個(gè)同事按照這個(gè)規(guī)范提交代碼，達(dá)到通過message能夠了解此次修改的內(nèi)容。

一、Commit message 的格式

每次提交，Commit message 都包括三個(gè)部分：Header，Body 和 Footer。

<type>(<scope>): <subject>
// 空一行
<body>

其中，Header、針對feat和fix類型的提交內(nèi)容 Body 是必需的。不管是哪一個(gè)部分，任何一行都不得超過72個(gè)字符（或100個(gè)字符）。這是為了避免自動換行影響美觀。

1.1 Header

Header部分只有一行，包括三個(gè)字段： type（必需）、scope（必需）和subject（必需）。
（1）type
type用于說明 commit 的類別，只允許使用下面7個(gè)標(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ī)則上下線等等，視項(xiàng)目不同而不同。
（3）subject
subject是 commit 目的的簡短描述，不超過50個(gè)字符。

1. 以動詞開頭，使用第一人稱現(xiàn)在時(shí)，比如change，而不是changed或changes
2. 第一個(gè)字母小寫
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.提交時(shí)選擇插件提交

到此這篇關(guān)于Java Git Commit Message使用規(guī)范的文章就介紹到這了,更多相關(guān)Java Git Commit Message內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

Java?Git?Commit?Message使用規(guī)范

目錄

概述