git提交時寫message的規範
阿新 • • 發佈:2018-07-30
lar clas actor eat 針對 amp doc 不同 www
message規範
angular示例
commit message(提交說明)
git commit -m "寫一行提交說明"
# 跳出文本編輯器,寫多行
git commit
# add && commit 註意:add只針對修改文件不包括新增加的文件
git commit -am ""
commit message格式
<type>(<scope>): <subject> // 空一行 <body> // 空一行 <footer> # 其中,Header 是必需的,Body 和 Footer 可以省略。 # 不管是哪一個部分,任何一行都不得超過72個字符(或100個字符)。這是為了避免自動換行影響美觀。
Header說明
# type feat:新功能(feature) fix:修補bug docs:文檔(documentation) style: 格式(不影響代碼運行的變動) refactor:重構(即不是新增功能,也不是修改bug的代碼變動) test:增加測試 chore:構建過程或輔助工具的變動 # scope scope用於說明 commit 影響的範圍,比如數據層、控制層、視圖層等等,視項目不同而不同。 # subject subject是 commit 目的的簡短描述,不超過50個字符。 - 以動詞開頭,使用第一人稱現在時,比如change,而不是changed或changes - 第一個字母小寫 - 結尾不加句號(.)
Body說明
Body 部分是對本次 commit 的詳細描述,可以分成多行。
(1)使用第一人稱現在時,比如使用change而不是changed或changes。
(2)應該說明代碼變動的動機,以及與以前行為的對比。
參考
- http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
- http://jartto.wang/2018/07/08/git-commit/
- https://www.aliyun.com/jiaocheng/125261.html
git提交時寫message的規範