如何寫好 Git commit messages

導語：任何軟件項目都是一個協(xié)作項目，它至少需要2個開發(fā)人員參與，當原始的開發(fā)人員將項目開發(fā)幾個星期或者幾個月之后，項目步入正規(guī)。不過他們或者后續(xù)的開發(fā)人員仍然需要經常提交一些代碼去修復bug或者實現(xiàn)新的feature。我們經常有這種感受：當一個項目時間過了很久之后，我們對于項目里面的文件和函數功能漸漸淡忘，重新去閱讀熟悉這部分代碼是很浪費時間并且惱人的一件事。但是這也沒法完全避免，我們可以使用一些技巧盡可能減少重新熟悉代碼的時間。commit messages可以滿足需要，它也反映了一個開發(fā)人員是否是良好的協(xié)作者。

編寫良好的Commit messages可以達到3個重要的目的：

  • 加快review的流程

  • 幫助我們編寫良好的版本發(fā)布日志

  • 讓之后的維護者了解代碼里出現(xiàn)特定變化和feature被添加的原因

先來看看一個比較好的例子，感受一下：
seo優(yōu)化培訓,網絡推廣培訓,網絡營銷培訓,SEM培訓,網絡優(yōu)化,在線營銷培訓

下面談談，如何讓項目里面的Commit messages步入規(guī)范化，流程化。

Commit messages的基本語法

<type>: <subject><BLANK LINE><body><BLANK LINE><footer>

Type表示提交類別，Subject表示標題行， Body表示主體描述內容。

Type的類別說明：

  • feat: 添加新特性

  • fix: 修復bug

  • docs: 僅僅修改了文檔

  • style: 僅僅修改了空格、格式縮進、都好等等，不改變代碼邏輯

  • refactor: 代碼重構，沒有加新功能或者修復bug

  • perf: 增加代碼進行性能測試

  • test: 增加測試用例

  • chore: 改變構建流程、或者增加依賴庫、工具等

Commit messages格式要求

        		
網友評論