国产av日韩一区二区三区精品,成人性爱视频在线观看,国产,欧美,日韩,一区,www.成色av久久成人,2222eeee成人天堂

Github上git commit 提交註解的規(guī)範(fàn)
ringa_lee
ringa_lee 2017-04-24 09:13:41
0
3
1033

例如註解有這樣的(轉(zhuǎn)載)

一般情況下,提交 GIT 時(shí)的註釋可以分成幾類,可以用幾個(gè)動(dòng)詞開(kāi)始:

  • Added ( 新加入的需求 )
  • Fixed ( 修復(fù) bug )
  • Changed ( 完成的任務(wù) )
  • Updated ( 完成的任務(wù),或因第三者模組變化而做的變化 )

盡量將註解縮減為一句話,不要包含詳細(xì)的內(nèi)容。
假如有 Issues 系統(tǒng),其中可以包含 Issue 的 ID。如:Issue #123456
包含作者的資訊。如 by Bruce
完整範(fàn)例:
git commit -m 'Issue #[issue number] 由 [username]: [Short summary of the change].'
Related articles

大家的註解方式規(guī)範(fàn)如何?

ringa_lee
ringa_lee

ringa_lee

全部回覆(3)
劉奇

個(gè)人的習(xí)慣:

  1. 修 Issue 就寫(xiě):fixed #XX
  2. 小改直接就用一句話說(shuō)清楚。
  3. 大改的,自己建一個(gè) Issue 說(shuō)清楚情況、方案、變化。 。 。 。 ,然後同 1

這裡還有一個(gè)好處是,commit log 裡面的 #XX GitHub 會(huì)顯示成指向?qū)?yīng) Issue 的鏈接,對(duì)應(yīng)地 Issue 裡面也會(huì)出現(xiàn)這條 Issue 被哪個(gè) commit 引用的提示。

更屌炸天的是,類似 fixed #XX 這樣的,GitHub 還會(huì)自動(dòng)幫你把那條 Issue 給 close 掉。


其實(shí)最重要一點(diǎn),commit log 是給人類看的,說(shuō)清楚就好,不必太過(guò)拘謹(jǐn),更不能寫(xiě)成只給機(jī)器看的東西。


反面教材。 。 。據(jù)說(shuō)這裡代表了兩個(gè)完全相反的派別。 。 。

大家講道理
  • Mod: remove unused code, 表示修改(Modify)
  • Add: a new module to have faster process, 表示新增(Add)
  • Rem: deprecate unused modules, 表示移除(Remove)
  • Ref: improved the implementation of module X, 表示重構(gòu)(Refactory)

有同學(xué)要問(wèn)了:如果一個(gè)commit裡的內(nèi)容無(wú)法用上述任一種語(yǔ)句陳述,該怎麼辦?
同學(xué),那表示你的commit應(yīng)該要拆分成多個(gè)小部分

當(dāng)然我最喜歡的commit message還是第一個(gè)commit,內(nèi)容是 First Blood

伊謝爾倫

推薦這篇文章 寫(xiě)好你的 Commit Message

最新下載
更多>
網(wǎng)站特效
網(wǎng)站源碼
網(wǎng)站素材
前端模板