《Netty官方指南》如何为一次提交写注释信息

原文链接 译者:麦芽面包

当对Netty做了一些改动后,请确保提交的注释里有足够的信息来让每个人理解变更的意图。除非提交很琐碎, 不然请用以下格式提交:

一句话描述你的变更:

  • 变更动机:解释的内容,和你为什么要做这个变更。你尝试要解决的问题。
  • 改动点:描述你都改了什么。
  • 结果:在你改动后,哪里会变动。

你如果喜欢可以将以上内容作为git提交的模板。想这么做的话,建一个包含以上内容的文件并且每行都加上#号。加上这个能防止git将注释提交上去。然后你可以运行一下git命令:

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

~/.git/commit.template可以是你想要的任何文件路径。

原创文章,转载请注明: 转载自并发编程网 – ifeve.com本文链接地址: 《Netty官方指南》如何为一次提交写注释信息



FavoriteLoading添加本文到我的收藏
  • Trackback are closed
  • Comments (0)
  1. No comments yet.

You must be logged in to post a comment.

return top