天天看點

Git commit comment 彙總标準

  參考彙總網際網路其它文章建議,結合PEP 257 Docstring Conventions的描述,總結的Git 注釋風格,作為個人執行的标準。内容如下:

遵循标準:

  1,所有注釋盡量堅持使用英文,如果用中文,盡量使用UTF-8編碼。

  2,注釋要清晰,隻有修正、改錯、更新等辨別,而沒有其他内容等于沒說。

  3,每個送出解決一個或一類問題。送出做好任務的分組,一個改動不一定一次送出完成,一次送出不一定完成所有改動。

書寫标準:

  1,第一行:為簡要總結,長度不超過 50字,采用指令式用語。首字母用大寫,結尾不使用标點符号。

  3,第二行為完全空行,不要tab鍵或空格鍵産生的空白行。

  4,第三行開始,是對改動的詳細介紹,可以是多行内容,建議每行長度不超過 72。可以包括原因、做法、效果等很多内容,一切你認為與目前改動相關的。

  為何是72長度呢?因為 git log 輸出的時候能顯示得比較好看, 前面4個空格作為縮進,後面留4個空格機動(英文按單詞排版)。

  5,注釋加字首分類,用幾個動詞開始:

  Added (新加入的需求)

  Fixed (修複bug )

  Changed (完成的任務)

  Updated (完成的任務,或者由于第三方子產品變化而做的變化)

  假如有 Issues 系統,其中可以包含 Issue 的 ID。比如:Issue #123456

  =================================================================

  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)

備注:

  如果配置了自動發送郵件,那麼第一行就用來做郵件标題, 第三行開始的内容是郵件正文, 第二行是分隔線,用于區分兩者。第一行被認為是個“标題”,也會作為郵件标題, 而标題是不需要标點的。

  字首的冒号後面跟一個空格比較好看。 為了控制字元串長度,子子產品名稱可适當縮寫,但應保持統一。

參考文章:

  http://www.fwolf.com/blog/post/14

  http://segmentfault.com/q/1010000000395039

git