Github上git commit 提交註解的規範
ringa_lee
ringa_lee 2017-04-24 09:13:41
0
3
943

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

一般情況下,提交 GIT 時的註釋可以分成幾類,可以用幾個動詞開始:

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

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

大家的註解方式規範如何?

ringa_lee
ringa_lee

ringa_lee

全部回覆(3)
刘奇

個人的習慣:

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

這裡還有一個好處是,commit log 裡面的 #XX GitHub 會顯示成指向對應 Issue 的鏈接,對應地 Issue 裡面也會出現這條 Issue 被哪個 commit 引用的提示。

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


其實最重要一點,commit log 是給人類看的,說清楚就好,不必太過拘謹,更不能寫成只給機器看的東西。


反面教材。 。 。據說這裡代表了兩個完全相反的派別。 。 。

大家讲道理
  • 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, 表示重構(Refactory)

有同學要問了:如果一個commit裡的內容無法用上述任一種語句陳述,該怎麼辦?
同學,那表示你的commit應該要拆分成多個小部分

當然我最喜歡的commit message還是第一個commit,內容是 First Blood

伊谢尔伦

推薦這篇文章 寫好你的 Commit Message

熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板