Day47 代碼提交規(guī)范

代碼提交規(guī)范

type 提交類型(required)

每個(gè)提交都必須使用類型字段前綴瘫絮,它由一個(gè)名詞組成抒蚜,諸如 feat 或 fix 苍鲜,其后接一個(gè)可選的作用域字段兄猩,以及一個(gè)必要的冒號(英文半角)和空格曹阔。

feat:當(dāng)一個(gè)提交為應(yīng)用或類庫實(shí)現(xiàn)了新特性時(shí)半开,必須使用 feat 類型
fix:當(dāng)一個(gè)提交為應(yīng)用修復(fù)了 bug 時(shí),必須使用 fix 類型
docs:只修改了文檔
style:做了不影響代碼含義的修改赃份,空格寂拆、格式化、缺少分號等等
refactor:進(jìn)行代碼重構(gòu)抓韩,既不是修復(fù)bug纠永,也不是新功能的修改
perf:改進(jìn)性能的代碼
test:增加測試或更新已有的測試
chore:構(gòu)建或輔助工具或依賴庫的更新

例如:

feat: 增加年審工單
fix: 修復(fù)運(yùn)維類請款單頁面內(nèi)存泄漏的問題
chore(release): AMS V2.18.0

scope 范圍

作用域字段可以跟隨在類型字段后面。作用域必須是一個(gè)描述某部分代碼的名詞谒拴,并用圓括號包圍尝江,例如: fix(parser)

description 描述(required)

描述字段必須緊接在類型/作用域前綴的空格之后。描述指的是對代碼變更的簡短總結(jié)彪薛,例如: fix: array parsing issue when multiple spaces were contained in string.

body 正文

在簡短描述之后茂装,可以編寫更長的提交正文,為代碼變更提供額外的上下文信息善延。正文必須起始于描述字段結(jié)束的一個(gè)空行后少态。

footer 頁腳注釋

在正文結(jié)束的一個(gè)空行之后,可以編寫一行或多行腳注易遣。腳注必須包含關(guān)于提交的元信息彼妻,例如:關(guān)聯(lián)的合并請求、Reviewer豆茫、破壞性變更侨歉,每條元信息一行。

BREAKING CHANGE 破壞性變更

  • 破壞性變更必須標(biāo)示在正文區(qū)域最開始處揩魂,或腳注區(qū)域中某一行的開始幽邓。一個(gè)破壞性變更必須包含大寫的文本 BREAKING CHANGE,后面緊跟冒號和空格火脉。
  • 在 BREAKING CHANGE: 之后必須提供描述牵舵,以描述對 API 的變更柒啤。例如: BREAKING CHANGE: environment variables now take precedence over config files.

FAQ

一次提交多種類型怎么操作?

盡可能拆分的task畸颅,每完成一部分就進(jìn)行一次提交担巩,避免一次提交過多的代碼。這樣能夠避免一次commit修改過多文件没炒,導(dǎo)致后續(xù)的維護(hù)涛癌,回退等的困難。
如果真的有這樣的提交送火,可以選擇最重要改動的type拳话,在body部分詳細(xì)寫明具體的改動。

參考:

約定式提交規(guī)范
你見過最奇葩的代碼提交信息是什么漾脂?別再為寫commit message頭疼了假颇!

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末胚鸯,一起剝皮案震驚了整個(gè)濱河市骨稿,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌姜钳,老刑警劉巖坦冠,帶你破解...
    沈念sama閱讀 218,941評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異哥桥,居然都是意外死亡辙浑,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,397評論 3 395
  • 文/潘曉璐 我一進(jìn)店門拟糕,熙熙樓的掌柜王于貴愁眉苦臉地迎上來判呕,“玉大人,你說我怎么就攤上這事送滞∠啦荩” “怎么了?”我有些...
    開封第一講書人閱讀 165,345評論 0 356
  • 文/不壞的土叔 我叫張陵犁嗅,是天一觀的道長边涕。 經(jīng)常有香客問我,道長褂微,這世上最難降的妖魔是什么功蜓? 我笑而不...
    開封第一講書人閱讀 58,851評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮宠蚂,結(jié)果婚禮上式撼,老公的妹妹穿的比我還像新娘。我一直安慰自己求厕,他們只是感情好著隆,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,868評論 6 392
  • 文/花漫 我一把揭開白布叠洗。 她就那樣靜靜地躺著,像睡著了一般旅东。 火紅的嫁衣襯著肌膚如雪灭抑。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,688評論 1 305
  • 那天抵代,我揣著相機(jī)與錄音腾节,去河邊找鬼。 笑死荤牍,一個(gè)胖子當(dāng)著我的面吹牛案腺,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播康吵,決...
    沈念sama閱讀 40,414評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼劈榨,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了晦嵌?” 一聲冷哼從身側(cè)響起同辣,我...
    開封第一講書人閱讀 39,319評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎惭载,沒想到半個(gè)月后旱函,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,775評論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡描滔,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評論 3 336
  • 正文 我和宋清朗相戀三年棒妨,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片含长。...
    茶點(diǎn)故事閱讀 40,096評論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡券腔,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出拘泞,到底是詐尸還是另有隱情纷纫,我是刑警寧澤,帶...
    沈念sama閱讀 35,789評論 5 346
  • 正文 年R本政府宣布田弥,位于F島的核電站涛酗,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏偷厦。R本人自食惡果不足惜商叹,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,437評論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望只泼。 院中可真熱鬧剖笙,春花似錦、人聲如沸请唱。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,993評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至聚至,卻和暖如春酷勺,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背扳躬。 一陣腳步聲響...
    開封第一講書人閱讀 33,107評論 1 271
  • 我被黑心中介騙來泰國打工脆诉, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人贷币。 一個(gè)月前我還...
    沈念sama閱讀 48,308評論 3 372
  • 正文 我出身青樓击胜,卻偏偏與公主長得像,于是被迫代替她去往敵國和親役纹。 傳聞我的和親對象是個(gè)殘疾皇子偶摔,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,037評論 2 355