git commit規(guī)范

Git 每次提交代碼,都要寫 Commit message(提交說明),否則就不允許提交。
一般來說,commit message 應該清晰明了,說明本次提交的目的。
每次提交,Commit message 都包括三個部分:Header,Body 和 Footer。
其中,Header 是必需的,Body 和 Footer 可以省略。
不管是哪一個部分,任何一行都不得超過72個字符(或100個字符)。這是為了避免自動換行影響美觀。

header

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

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

Merge: merge branch
Feature: a new module to have faster process, 表示新增(Add)
Update: update something
Refactor: improved the implementation of module X, 表示重構(Refactory)
Bugfix: fixed a bug

scope

scope用于說明 commit 影響的范圍,比如數(shù)據(jù)層、控制層、視圖層等等,視項目不同而不同。

subject

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

好的commit信息建議
touch README.md
git init
git add README.md
# git commit -m "first commit" # 命令行添加提交信息
git commit # 編輯器添加提交信息
七條很棒的 git 提交信息規(guī)則
記住:這都是之前都說過的。

1.用一個空行隔開標題和正文
2.限制標題字數(shù)在 50 個字符內
3.用大寫字母寫標題行
4.不要用句號結束標題行
5.在標題行使用祈使語氣
6.正文在 72 個字符處換行
7.使用正文解釋是什么和為什么,而不是如何做
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容