AD
首页 > 头条 > 正文

Square 公司怎么写提交信息

[2017-05-21 22:07:33] 来源:百度网百度 VR 编辑:百度 VR 点击量:
评论 点击收藏
导读:▼点击下方收听音频Square...
▼点击下方收听音频 Square 公司怎么写提交信息 来自VR
https://imgs.xkcd.com/comics/git_commit_2x.pngSquare 公司怎么写提交信息
解释变化
在 Square 提交信息是很重要的交流形式,所以写好提交信息是很好的为大家节约时间的方式。我们常常希望以前能够做的更好。那些时候的提交信息仍然存在,并且很多仍然非常重要。
我们搜集了我们投入在出色的提交信息上的各种想法,这不仅是为了短期内节约我们的时间,从长远来看也可以。现在我们将它们分享出来希望同时也对你的团队有所帮助。
TL;DR: 优秀的提交信息解释了变化在 Square, 我们编写了大量的代码。最好的代码应当是不言自明的。当我们的代码表述性不够的时候,就会有注释来解释这段代码做什么事情,或者更进一步,为什么它要这么做。一个开发者如果去阅读 SHA 的代码,他就能理解它做了什么事情以及为什么它要以那样的方式去完成。
提交信息不是关于代码的,它们是关于变化本身的。这是一个至关重要的差别,但是这个差别常常被忽视。
当我们进行提交时,我们会将一些理想状态下很清晰、自解释的代码覆盖其他一些很清晰、自解释的代码。不管修改前后的代码有多么清晰,这两者之间仍然会有内容的差别。提交信息就是建立在这个差别之间的桥梁。
提交信息有两个读者考虑下提交信息的读者。一般分为两类:代码检查者和挖坟者。
直接读者应该是代码检查者,他需要决定是否接受这次改变,以及代码的改变是否反映作者的意图。代码检查者为了评估,则需要了解变化的背景,对他们而言,如果有信息可以为该代码变化提供背景知识,而不需要通过修改前后的代码来推断,会容易很多。
从长期看,提交信息的读者应该是某一位开发者,他尝试修复软件中的某一个问题、移除不再使用的代码、在现有的代码基础上开发新的功能、或仅仅是做出相似的改变、或是这些事情中的几个。有时候,某一位开发者尝试理解过去的一个决定(通常是作者本人!)。这就是考古学,如果每一条提交信息都有一条帮助性的信息解释这些改变,事情就变得非常容易。否则,挖坟者除了通过比较修改前后的内容来重建提交者的思考过程别无他法--这通常是不可能完成的任务。
查看更多:AR