Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
机器未来
Paddle
提交
f23ee80d
P
Paddle
项目概览
机器未来
/
Paddle
与 Fork 源项目一致
Fork自
PaddlePaddle / Paddle
通知
1
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
1
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
P
Paddle
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
1
Issue
1
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
f23ee80d
编写于
5月 11, 2017
作者:
G
gongweibao
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Fix bugs
上级
d7bde1ff
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
5 addition
and
5 deletion
+5
-5
doc/howto/dev/introduction_to_pr.md
doc/howto/dev/introduction_to_pr.md
+5
-5
未找到文件。
doc/howto/dev/introduction_to_pr.md
浏览文件 @
f23ee80d
...
...
@@ -2,7 +2,7 @@
## 前言
故事还要从前两天我提交的
[
FileManager
](
https://github.com/PaddlePaddle/Paddle/pull/2013
)
的Design Doc PR开始。
我肯定是用心写了,我也清楚地记得,提交之前也仔细的检查了(这点自觉性还是有的),结果,我突然发现,我的PR被Comments刷屏了;这还是其次,更要命的是,当网络速度稍慢的时候会提示我:Comments 太多啦!页面打不开!!哦。简直有点人间惨剧的味道!我要把这些和之前的Comments以及一些典型的Comments总结一下,避免同样的问题,同时也希望对您有用。
这个文档
我肯定是用心写了,我也清楚地记得,提交之前也仔细的检查了(这点自觉性还是有的),结果,我突然发现,我的PR被Comments刷屏了;这还是其次,更要命的是,当网络速度稍慢的时候会提示我:Comments 太多啦!页面打不开!!哦。简直有点人间惨剧的味道!我要把这些和之前的Comments以及一些典型的Comments总结一下,避免同样的问题,同时也希望对您有用。
我觉得里边有几个基本的原则:
...
...
@@ -103,18 +103,18 @@
应该都是陈述句的描述。有不确定的问题可以提Issue来讨论获得结论。
对于自己不确定的地方,与其含混而过不如找人讨论先搞一个靠谱的可以讨论的。绝大多数情况下,这种含混而过的都会被Reivew给纠出来。即便就不出来,岂不是自己给自己埋一个坑?
-
文档当中不要黏贴大量的代码
-
文档当中不要黏贴大量的代码
代码一般都是细节,改变的非常的快,文档可能很快就失效了,需要重新的修正。另外,最主要的是大段的代码会让人的思路中断,陷于实现的细节当中。
-
不准备实现的就不要写了
-
不准备实现的就不要写了
最多放到放到
`Future`
中展望一下。
## 文笔要好
啊呀,不想当作家的程序员不是好程序员。这个当然比较难,要看大家的“学好数理化,走遍天下都不怕”的基本功的“深厚”程度了:)
推荐一下公众号:老万故事会
[
link
](
https://freewechat.com/profile/MzI1MDQ3NTAxOQ==
)
,一个文章和代码写的一样好的人
<sup>
[
yi
](
#yi
)
</sup>
。
顺便
推荐一下公众号:老万故事会
[
link
](
https://freewechat.com/profile/MzI1MDQ3NTAxOQ==
)
,一个文章和代码写的一样好的人
<sup>
[
yi
](
#yi
)
</sup>
。
## 参考
资料
## 参考
-
<a
name=
yi
>
WangYi
</a>
-
<a
name=
WuYi
>
WuYi
</a>
-
<a
name=
Helin
>
Helin
</a>
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录