約定式提交

什么是約定式提交?

約定式提交規(guī)范是一種基于提交消息的輕量級約定苫纤。所謂輕量級約定阔籽,說白了,就是有一套用于創(chuàng)建提交消息的簡單規(guī)則驹马,這套規(guī)則源自于Angular 提交規(guī)范

Commit Message Format

 <type>[optional scope]: <description>

[optional body]

[optional footer]

翻譯成中文就是:

<類型>[可選 范圍]: <描述>

[可選 正文]

[可選 腳注]

每一條提交信息包含header革砸、body、footer糯累。header包含type算利、scope和description三部分。

header

type

  • feat: 新功能
  • fix: 修復bug
  • docs: 只改動了文檔
  • style: 修改代碼格式(例如去掉空格泳姐、改變縮進效拭、增刪分號,不影響代碼邏輯)
  • refactor: 重構代碼(非修復bug和增加新功能)
  • perf: 提升性能的改動
  • test: 添加或修改測試代碼(Adding missing or correcting existing tests)
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
  • revert:回滾到上一個版本
  • ci:持續(xù)集成
  • build:構建版本

scope

代碼變更影響的范圍

  • 名詞
  • 圓括號包圍胖秒,例如fix(parser)

description

代碼變更的簡短描述

body

選填項缎患,相對于上述的description,body用于更加詳細的描述本次提交中所做出的修改阎肝。其中需要包括:

  • 本次修改的動機
  • 對比于修改之前的改進之處

footer

footer 部分一般用于記錄不兼容的改動挤渔,以 BREAKING CHANGE 開頭,后面是對變動的描述风题、以及變動理由和遷移方法判导。最后還可以添加關閉的 issue。

為什么要用約定式提交沛硅?

  • 自動化生成 CHANGELOG眼刃。
  • 基于提交的類型,自動決定語義化的版本變更摇肌。
  • 向同事鸟整、公眾與其他利益關系者傳達變化的性質。
  • 觸發(fā)構建和部署流程朦蕴。
  • 讓人們探索一個更加結構化的提交歷史篮条,以便降低對你的項目做出貢獻的難度。

如何在項目中規(guī)范化地提交吩抓?

Commit Message Editor

Commit Message Editor是一款基于VScode可支持文本式和表格式兩種提交方式的工具涉茧。


Commit Message Editor.png

進入Commit Message Editor

image.png

文本式提交

文本式提交.png

表格式提交

表格式提交.png
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市疹娶,隨后出現(xiàn)的幾起案子伴栓,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,104評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件钳垮,死亡現(xiàn)場離奇詭異惑淳,居然都是意外死亡,警方通過查閱死者的電腦和手機饺窿,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,816評論 3 399
  • 文/潘曉璐 我一進店門歧焦,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人肚医,你說我怎么就攤上這事绢馍。” “怎么了肠套?”我有些...
    開封第一講書人閱讀 168,697評論 0 360
  • 文/不壞的土叔 我叫張陵舰涌,是天一觀的道長。 經(jīng)常有香客問我你稚,道長瓷耙,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 59,836評論 1 298
  • 正文 為了忘掉前任刁赖,我火速辦了婚禮哺徊,結果婚禮上,老公的妹妹穿的比我還像新娘乾闰。我一直安慰自己落追,他們只是感情好,可當我...
    茶點故事閱讀 68,851評論 6 397
  • 文/花漫 我一把揭開白布涯肩。 她就那樣靜靜地躺著轿钠,像睡著了一般。 火紅的嫁衣襯著肌膚如雪病苗。 梳的紋絲不亂的頭發(fā)上疗垛,一...
    開封第一講書人閱讀 52,441評論 1 310
  • 那天,我揣著相機與錄音硫朦,去河邊找鬼贷腕。 笑死,一個胖子當著我的面吹牛咬展,可吹牛的內容都是我干的泽裳。 我是一名探鬼主播,決...
    沈念sama閱讀 40,992評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼破婆,長吁一口氣:“原來是場噩夢啊……” “哼涮总!你這毒婦竟也來了?” 一聲冷哼從身側響起祷舀,我...
    開封第一講書人閱讀 39,899評論 0 276
  • 序言:老撾萬榮一對情侶失蹤瀑梗,失蹤者是張志新(化名)和其女友劉穎烹笔,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體抛丽,經(jīng)...
    沈念sama閱讀 46,457評論 1 318
  • 正文 獨居荒郊野嶺守林人離奇死亡谤职,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 38,529評論 3 341
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了亿鲜。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片允蜈。...
    茶點故事閱讀 40,664評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖狡门,靈堂內的尸體忽然破棺而出陷寝,到底是詐尸還是另有隱情锅很,我是刑警寧澤其馏,帶...
    沈念sama閱讀 36,346評論 5 350
  • 正文 年R本政府宣布,位于F島的核電站爆安,受9級特大地震影響叛复,放射性物質發(fā)生泄漏。R本人自食惡果不足惜扔仓,卻給世界環(huán)境...
    茶點故事閱讀 42,025評論 3 334
  • 文/蒙蒙 一褐奥、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧翘簇,春花似錦撬码、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,511評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至彻犁,卻和暖如春叫胁,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背汞幢。 一陣腳步聲響...
    開封第一講書人閱讀 33,611評論 1 272
  • 我被黑心中介騙來泰國打工驼鹅, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人森篷。 一個月前我還...
    沈念sama閱讀 49,081評論 3 377
  • 正文 我出身青樓输钩,卻偏偏與公主長得像,于是被迫代替她去往敵國和親仲智。 傳聞我的和親對象是個殘疾皇子张足,可洞房花燭夜當晚...
    茶點故事閱讀 45,675評論 2 359