Git 提交規範

2021-08-25 02:44:07 字數 1553 閱讀 2635

無規矩不成方圓,程式設計也一樣。

乙個commit只做一件事情,若乙個commit做了多件事情需要拆分成多個commit

嚴格遵循commit message格式

每次只允許提交乙個commit,若本地有多個commit等待提交,必須等前面的commit合併進入主版本庫並在本地合併完成後才可提交後面的commit

在commit log中,要寫清楚以下幾點內容:

這個commit解決了哪個問題,或者實現了哪個功能,需要有對應的bug url或者功能列表url;

如果是個bug fix,請詳述之前存在什麼問題,這個commit是如何解決的;

如果這個commit只是乙個大的過程中的某一步,請註明,並且簡要列出這個commit之後還需要做的事情;

如果有需要提醒審核者注意的問題,比如乙個known bug,或者還有某些已知問題,或者需要未來重構,請用「notice:」另起一行標註並說明。

git commit 規範可能並沒有那麼誇張,但如果你在版本回退的時候看到一大段糟心的 commit,恐怕會懊惱不已吧。所以,嚴格遵守規範,利人利己,建議大家養成良好的開發習慣。

每次提交,commit message 都包括三個部分:header,body 和 footer。

():
其中,header 是必需的,body 和 footer 可以省略。

不管是哪乙個部分,任何一行都不得超過72個字元(或100個字元)。這是為了避免自動換行影響美觀。

header

header部分只有一行,包括三個字段:type(必需)、scope(可選)和subject(必需)。

type

用於說明 commit 的類別,只允許使用下面7個標識。

如果type為feat和fix,則該 commit 將肯定出現在 change log 之中。其他情況(docs、chore、style、refactor、test)由你決定,要不要放入 change log,建議是不要。

scope

scope用於說明 commit 影響的範圍,比如資料層、控制層、檢視層等等,視專案不同而不同。

如果你的修改影響了不止乙個scope,你可以使用*代替。

subject

subject是 commit 目的的簡短描述,不超過50個字元。

其他注意事項:

body

body 部分是對本次 commit 的詳細描述,可以分成多行。下面是乙個範例。

more detailed explanatory text, if necessary. wrap it to

about 72 characters or so.

further paragraphs come after blank lines.

有兩個注意點:

footer

footer 部分只用於以下兩種情況:

Git提交規範

type為必填項,用於指定commit的型別,約定了feat fix兩個主要type,以及docs style build refactor revert五個特殊type,其餘type暫不使用。主要type feat 增加新功能 fix 修復bug 特殊type docs 只改動了文件相關的內容 s...

GIT提交message規範

type 用於說明 commit 的類別,只允許使用下面7個標識。feat 新功能 feature fix 修補bug docs 文件 documentation style 格式 不影響 執行的變動 refactor 重構 即不是新增功能,也不是修改bug的 變動 perf 效能優化 test 增...

Git的使用和提交規範

1.git初始化 安裝完成後,在github或者gitlab上覆制http的clone鏈結,開啟git bash git clone git config global user.name username git config global user.email email 將生成的ssh key...