提交 dda59154 编写于 作者: Enstein_Jun's avatar Enstein_Jun

微调翻译结果

上级 dccf2b67
# 写一个好的CL描述
一个CL描述是做了**什么**更改以及**为什么**的公开记录。
它将成为我们版本控制历史的永久组成部分,多年来除你的reviewer以外,还有数百人可能会阅读它。
它将成为我们版本控制历史的永久组成部分,多年来除你的reviewer以外,还可能有数百人会阅读它。
将来的开发者将会基于它的描述来搜索你的CL。
将来可能会有人由于没有现成的细节,而根据他模糊的记忆来寻找你的改变。
如果所有重要的细节都在代码中而不是描述中,那么他们将很难定位你的CL。
......@@ -13,7 +13,7 @@
* 接着紧跟一个空行
CL描述的**第一行**应该是对CL正在**做的***具体*工作的简短总结,紧跟一个空行。
这是大多数未来的代码搜索者在浏览一段代码的版本控制历史时会看到的,因此第一行应该足够有信息量,他们不必阅读你的CL或它的整个描述就可以大致了解你的CL实际做了什么。
在未来,这是大多数的代码搜索者在浏览一段代码的版本控制历史时会看到的,因此第一行应该足够有信息量,他们不必阅读你的CL或它的整个描述就可以大致了解你的CL实际做了什么。
按照传统,CL描述的第一行是一个完整的句子,就像它是一个命令(一个祈使句)。
例如,说\"**Delete** the FizzBuzz RPC and **replace** it with the new system.",而不是\"**Deleting** the FizzBuzz RPC and **replacing** it with the new system."。
不过,你不必把其余的描述写成祈使句。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册