例如註解有這樣的(轉(zhuǎn)載)
一般情況下,提交 GIT 時(shí)的註釋可以分成幾類,可以用幾個(gè)動(dòng)詞開(kāi)始:
盡量將註解縮減為一句話,不要包含詳細(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
個(gè)人的習(xí)慣:
fixed #XX
這裡還有一個(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