利用commit log提高项目的可维护性

作者: zhangzhongke 分类: Tools,开发工具 发布时间: 2017-06-23 16:31

事出有因

  某天在学习OBS Studio的时候,很偶然的看了一下commit log

  当时我就震惊了,这么整洁划一的log,不光看着舒服,后期维护的时候对于修改记录也是一目了然呢。显然,这样优良的工程实践是必须要吸收的。毕竟,commit时代码的变化只是说明了改动了什么;而commit log则说明了为什么要这么改!这才是项目维护时的快速理解项目的关键信息。
  git commit是git实践中最为常用的命令之一。自己平常在使用的时候,经常是使用git commit -m “description message”了事。但往往有时候自己在回顾项目的时候,发现那些只言片语的log聊胜于无。更多的时候,log中只是一些类似于”update”的信息,根本没有对修改目的做出任何有帮助的说明。这样的日志,还不如不要。这根本没有发挥出git应有的强大的功能嘛!暴殄天物!!
  那么今天,我们就来学学,怎么修改自己的commit log风格,争取向业界标准看齐。

实践方法

  首先,我们需要编写一个commit模板文件。当我们试图通过“git commit”命令进行提交时,git将在指定的文本编辑器(如果没有自行设置,一般是vi)中打开这个文件,作为commit message的模板:

  将.gitmessage.txt文件保存到用户根目录下。然后使用如下命令设置commit template:


git config --global commit.template ~/.gitmessage.txt

  到这里就OK了。我们以后如果需要commit代码,只需要执行git commit即可,git将自动用文本编辑器打开commit模板文件:

  修改完占位文本后保存退出,即提交了!我们的log终于也具备了良好的可读样式。

参考链接

发表评论

电子邮件地址不会被公开。 必填项已用*标注