《Netty官方指南》如何為一次提交寫注釋信息
當對Netty做了一些改動後,請確保提交的注釋裏有足夠的信息來讓每個人理解變更的意圖。除非提交很瑣碎, 不然請用以下格式提交:
一句話描述你的變更:
- 變更動機:解釋的內容,和你為什麼要做這個變更。你嚐試要解決的問題。
- 改動點:描述你都改了什麼。
- 結果:在你改動後,哪裏會變動。
你如果喜歡可以將以上內容作為git提交的模板。想這麼做的話,建一個包含以上內容的文件並且每行都加上#號。加上這個能防止git將注釋提交上去。然後你可以運行一下git命令:
git config commit.template ~/.git.commit.template
~/.git/commit.template可以是你想要的任何文件路徑。
最後更新:2017-05-19 09:31:21