摘要:我最近在忙着处理一个第三方整合方面的问题,这个问题突然出现在我眼前,而且没有明显的原因。问题的来源,是页面上的一个iframe突然无法正常工作了。
我最近在忙着处理一个第三方整合方面的问题,这个问题突然出现在我眼前,而且没有明显的原因。问题的来源,是页面上的一个iframe突然无法正常工作了。
我的第一反应,就是对包含这个iframe的那行代码进行git blame,看看代码上一次改变是在什么时候,以及改变的内容。我立刻就发现了变更:
-
+ <iframe src="https://fake-3rd-party.com/embed/WXYZ" /></code></pre><p>它意味着,在整合过程中,一个东西可能出现了改变,并且引发了这个问题。于是我开始查看commit message,试图找到更多的信息,我注意到:</p><pre><code> Author: Some Guy <some.guy@some.domain>
changed iframe src</code></pre><p>原来如此!多谢你了,Some Guy!</p><p>但是故事还没有结束,我才刚刚开始要阐述我的观点。</p><p>当我们下次写commit message的时候,让我们花时间想一想,这个messege是否能够提供有用信息?我们是否应该在里面加一些其他的信息,让别人能理解究竟发生了什么?比如一个链接,或是其他能说明问题的东西。</p><p>如果你确实不知道应该写什么才能让message变得有用,你不妨问自己一个问题:“我为什么要做出这个变更?”考虑好这个问题之后,至少你可以将做出这次变更的动机写在message中。至少,在了解了你的动机之后,其他人在进行深一步的调查的时候能更轻松一点。</p><p>从现在开始,我们应该将这种“为什么要进行变更”的内容,写在commit message中。</p><p><img alt="sdk.jpg" src="https://dn-sdkcnssl.qbox.me/editor/ZmL9HBWxhjCxy-8nsOum.jpg" style=""><br></p><blockquote>原 文:<a href="https://8thlight.com/blog/dariusz-pasciak/2016/10/31/the-why-a-better-git-commit-message.html?utm_source=wanqu.co&utm_campaign=Wanqu+Daily&utm_medium=website">The Why: A Better Git Commit Message</a><br>译 文:SDK.cn<br>作 者:鲁行云(编译)<br></blockquote>
</div>
</div></div>