1. 程式人生 > >《Netty官方指南》如何為一次提交寫註釋資訊

《Netty官方指南》如何為一次提交寫註釋資訊

當對Netty做了一些改動後,請確保提交的註釋裡有足夠的資訊來讓每個人理解變更的意圖。除非提交很瑣碎, 不然請用以下格式提交:

一句話描述你的變更:

  • 變更動機:解釋的內容,和你為什麼要做這個變更。你嘗試要解決的問題。
  • 改動點:描述你都改了什麼。
  • 結果:在你改動後,哪裡會變動。

你如果喜歡可以將以上內容作為git提交的模板。想這麼做的話,建一個包含以上內容的檔案並且每行都加上#號。加上這個能防止git將註釋提交上去。然後你可以執行一下git命令:

git config commit.template ~/.git.commit.template

~/.git/commit.template可以是你想要的任何檔案路徑。