Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
xindoo
eng-practices-cn
提交
dda59154
E
eng-practices-cn
项目概览
xindoo
/
eng-practices-cn
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
E
eng-practices-cn
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
前往新版Gitcode,体验更适合开发者的 AI 搜索 >>
提交
dda59154
编写于
9月 30, 2019
作者:
Enstein_Jun
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
微调翻译结果
上级
dccf2b67
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
2 addition
and
2 deletion
+2
-2
review/developer/cl-descriptions.md
review/developer/cl-descriptions.md
+2
-2
未找到文件。
review/developer/cl-descriptions.md
浏览文件 @
dda59154
# 写一个好的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.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录