Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
PaddlePaddle
FluidDoc
提交
5e42ecee
F
FluidDoc
项目概览
PaddlePaddle
/
FluidDoc
通知
5
Star
2
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
23
列表
看板
标记
里程碑
合并请求
111
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
F
FluidDoc
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
23
Issue
23
列表
看板
标记
里程碑
合并请求
111
合并请求
111
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
5e42ecee
编写于
11月 16, 2018
作者:
S
shanyi15
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
polish_how_to_commit
上级
c93fe539
变更
6
显示空白变更内容
内联
并排
Showing
6 changed file
with
133 addition
and
66 deletion
+133
-66
doc/fluid/advanced_usage/development/contribute_to_paddle/img/cla_unsigned.png
...age/development/contribute_to_paddle/img/cla_unsigned.png
+0
-0
doc/fluid/advanced_usage/development/contribute_to_paddle/img/sign_cla.png
...d_usage/development/contribute_to_paddle/img/sign_cla.png
+0
-0
doc/fluid/advanced_usage/development/contribute_to_paddle/index_cn.rst
...anced_usage/development/contribute_to_paddle/index_cn.rst
+9
-0
doc/fluid/advanced_usage/development/contribute_to_paddle/local_dev_guide.md
...usage/development/contribute_to_paddle/local_dev_guide.md
+12
-65
doc/fluid/advanced_usage/development/contribute_to_paddle/submit_pr_guide.md
...usage/development/contribute_to_paddle/submit_pr_guide.md
+111
-0
doc/fluid/advanced_usage/index.rst
doc/fluid/advanced_usage/index.rst
+1
-1
未找到文件。
doc/fluid/advanced_usage/development/contribute_to_paddle/img/cla_unsigned.png
0 → 100644
浏览文件 @
5e42ecee
55.6 KB
doc/fluid/advanced_usage/development/contribute_to_paddle/img/sign_cla.png
0 → 100644
浏览文件 @
5e42ecee
1.2 MB
doc/fluid/advanced_usage/development/contribute_to_paddle/index_cn.rst
0 → 100644
浏览文件 @
5e42ecee
########
如何贡献代码
########
.. toctree::
:maxdepth: 2
local_dev_guide.md
submit_pr_guide.md
doc/fluid/advanced_usage/development/contribute_to_paddle.md
→
doc/fluid/advanced_usage/development/contribute_to_paddle
/local_dev_guide
.md
浏览文件 @
5e42ecee
#
如何贡献代码
#
本地开发指南
我们真诚地感谢您的贡献,欢迎通过 GitHub 的 fork 和 pull request 流程来提交代码。
本文将指导您如何在本地进行代码开发
## 代码要求
## 代码要求
-
代码注释请遵守
[
Doxygen
](
http://www.stack.nl/~dimitri/doxygen/
)
的样式。
-
代码注释请遵守
[
Doxygen
](
http://www.stack.nl/~dimitri/doxygen/
)
的样式。
...
@@ -146,6 +146,16 @@ clang-formater.......................................(no files to check)Skipped
...
@@ -146,6 +146,16 @@ clang-formater.......................................(no files to check)Skipped
create mode 100644 233
create mode 100644 233
```
```
<b>
<font
color=
"red"
>
需要注意的是:您需要在commit中添加说明(commit message)以触发CI单测,写法如下:
</font>
</b>
```
bash
# 触发develop分支的CI单测
➜ git commit
-m
"test=develop"
# 触发release/1.1分支的CI单侧
➜ git commit
-m
"test=release/1.1"
```
## 保持本地仓库最新
## 保持本地仓库最新
在准备发起 Pull Request 之前,需要同步原仓库(
<https://github.com/PaddlePaddle/Paddle>
)最新的代码。
在准备发起 Pull Request 之前,需要同步原仓库(
<https://github.com/PaddlePaddle/Paddle>
)最新的代码。
...
@@ -184,66 +194,3 @@ upstream
...
@@ -184,66 +194,3 @@ upstream
# 推送到远程仓库 origin 的 my-cool-stuff 分支上
# 推送到远程仓库 origin 的 my-cool-stuff 分支上
➜ git push origin my-cool-stuff
➜ git push origin my-cool-stuff
```
```
## 建立 Issue 并完成 Pull Request
建立一个 Issue 描述问题,并记录它的编号。
切换到所建分支,然后点击
`New pull request`
。
<img
width=
"295"
alt=
"screen shot 2017-04-26 at 9 09 28 pm"
src=
"https://cloud.githubusercontent.com/assets/11692045/25436054/a6d98c66-2ac4-11e7-9cb1-18dd13150230.png"
>
选择目标分支:
<img
width=
"750"
alt=
"screen shot 2017-04-26 at 9 11 52 pm"
src=
"https://cloud.githubusercontent.com/assets/11692045/25436139/f83b1e6c-2ac4-11e7-8c0e-add499023c46.png"
>
在 PR 的描述说明中,填写
`resolve #Issue编号`
可以在这个 PR 被 merge 后,自动关闭对应的 Issue,具体请见
<https://help.github.com/articles/closing-issues-via-commit-messages/>
。
接下来等待 review,如果有需要修改的地方,参照上述步骤更新 origin 中的对应分支即可。
## 删除远程分支
在 PR 被 merge 进主仓库后,我们可以在 PR 的页面删除远程仓库的分支。
<img
width=
"775"
alt=
"screen shot 2017-04-26 at 9 18 24 pm"
src=
"https://cloud.githubusercontent.com/assets/11692045/25436457/e4cdd472-2ac5-11e7-9272-badc76c4a23e.png"
>
也可以使用
`git push origin :分支名`
删除远程分支,如:
```
bash
➜ git push origin :my-cool-stuff
```
## 删除本地分支
最后,删除本地分支。
```
bash
# 切换到 develop 分支
➜ git checkout develop
# 删除 my-cool-stuff 分支
➜ git branch
-D
my-cool-stuff
```
至此,我们就完成了一次代码贡献的过程。
## 提交代码的一些约定
为了使评审人在评审代码时更好地专注于代码本身,请您每次提交代码时,遵守以下约定:
1.
请保证Travis-CI 中单元测试能顺利通过。如果没过,说明提交的代码存在问题,评审人一般不做评审。
2.
提交PUll Request前:
-
请注意commit的数量:
-
原因:如果仅仅修改一个文件但提交了十几个commit,每个commit只做了少量的修改,这会给评审人带来很大困扰。评审人需要逐一查看每个commit才能知道做了哪些修改,且不排除commit之间的修改存在相互覆盖的情况。
-
建议:每次提交时,保持尽量少的commit,可以通过
`git commit --amend`
补充上次的commit。对已经Push到远程仓库的多个commit,可以参考
[
squash commits after push
](
http://stackoverflow.com/questions/5667884/how-to-squash-commits-in-git-after-they-have-been-pushed
)
。
-
请注意每个commit的名称:应能反映当前commit的内容,不能太随意。
3.
如果解决了某个Issue的问题,请在该PUll Request的
**第一个**
评论框中加上:
`fix #issue_number`
,这样当该PUll Request被合并后,会自动关闭对应的Issue。关键词包括:close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved,请选择合适的词汇。详细可参考
[
Closing issues via commit messages
](
https://help.github.com/articles/closing-issues-via-commit-messages
)
。
此外,在回复评审人意见时,请您遵守以下约定:
1.
评审人的每个意见都必须回复(这是开源社区的基本礼貌,别人帮了忙,应该说谢谢):
-
对评审意见同意且按其修改完的,给个简单的
`Done`
即可;
-
对评审意见不同意的,请给出您自己的反驳理由。
2.
如果评审意见比较多:
-
请给出总体的修改情况。
-
请采用
[
start a review
](
https://help.github.com/articles/reviewing-proposed-changes-in-a-pull-request/
)
进行回复,而非直接回复的方式。原因是每个回复都会发送一封邮件,会造成邮件灾难。
doc/fluid/advanced_usage/development/contribute_to_paddle/submit_pr_guide.md
0 → 100644
浏览文件 @
5e42ecee
# Github提交PR指南
## 建立 Issue 并完成 Pull Request
建立一个 Issue 描述问题,并记录它的编号。
切换到所建分支,然后点击
`New pull request`
。
<img
width=
"295"
alt=
"screen shot 2017-04-26 at 9 09 28 pm"
src=
"https://cloud.githubusercontent.com/assets/11692045/25436054/a6d98c66-2ac4-11e7-9cb1-18dd13150230.png"
>
选择目标分支:
<img
width=
"750"
alt=
"screen shot 2017-04-26 at 9 11 52 pm"
src=
"https://cloud.githubusercontent.com/assets/11692045/25436139/f83b1e6c-2ac4-11e7-8c0e-add499023c46.png"
>
在 PR 的描述说明中,填写
`resolve #Issue编号`
可以在这个 PR 被 merge 后,自动关闭对应的 Issue,具体请见
[
这里
](
https://help.github.com/articles/closing-issues-via-commit-messages/
)
。
接下来等待 review,如果有需要修改的地方,参照上述步骤更新 origin 中的对应分支即可。
## 签署CLA协议和通过单元测试
### 签署CLA
在首次向PaddlePaddle提交Pull Request时,您需要您签署一次CLA(Contributor License Agreement)协议,以保证您的代码可以被合入,具体签署方式如下:
-
请您查看PR中的Check部分,找到license/cla,并点击右侧detail,进入CLA网站
<div
align=
"center"
>
<img
src=
"./img/cla_unsigned.png"
height=
"330"
width=
"400"
>
</div>
-
请您点击CLA网站中的“Sign in with GitHub to agree”,点击完成后将会跳转回您的Pull Request页面
<div
align=
"center"
>
<img
src=
"./img/sign_cla.png"
height=
"330"
width=
"400"
>
</div>
### 通过单元测试
您在Pull Request中每提交一次新的commit后,会触发CI单元测试,请确认您的commit message中已加入必要的说明,请见
[
提交(commit)
](
local_dev_guide.html#permalink-8--commit-
)
请您关注您Pull Request中的CI单元测试进程,它将会在几个小时内完成
您仅需要关注和自己提交的分支相关的CI项目,例如您向develop分支提交代码,则无需关注release/1.1一栏是否通过测试
当所需的测试后都出现了绿色的对勾,表示您本次commit通过了各项单元测试
如果所需的测试后出现了红色叉号,代表您本次的commit未通过某项单元测试,在这种情况下,请您点击detail查看报错详情,并将报错原因截图,以评论的方式添加在您的Pull Request中,我们的工作人员将帮您查看
## 删除远程分支
在 PR 被 merge 进主仓库后,我们可以在 PR 的页面删除远程仓库的分支。
<img
width=
"775"
alt=
"screen shot 2017-04-26 at 9 18 24 pm"
src=
"https://cloud.githubusercontent.com/assets/11692045/25436457/e4cdd472-2ac5-11e7-9272-badc76c4a23e.png"
>
也可以使用
`git push origin :分支名`
删除远程分支,如:
```
bash
➜ git push origin :my-cool-stuff
```
## 删除本地分支
最后,删除本地分支。
```
bash
# 切换到 develop 分支
➜ git checkout develop
# 删除 my-cool-stuff 分支
➜ git branch
-D
my-cool-stuff
```
至此,我们就完成了一次代码贡献的过程。
## 提交代码的一些约定
为了使评审人在评审代码时更好地专注于代码本身,请您每次提交代码时,遵守以下约定:
1)请保证Travis-CI 中单元测试能顺利通过。如果没过,说明提交的代码存在问题,评审人一般不做评审。
2)提交PUll Request前:
-
请注意commit的数量:
原因:如果仅仅修改一个文件但提交了十几个commit,每个commit只做了少量的修改,这会给评审人带来很大困扰。评审人需要逐一查看每个commit才能知道做了哪些修改,且不排除commit之间的修改存在相互覆盖的情况。
建议:每次提交时,保持尽量少的commit,可以通过
`git commit --amend`
补充上次的commit。对已经Push到远程仓库的多个commit,可以参考
[
squash commits after push
](
http://stackoverflow.com/questions/5667884/how-to-squash-commits-in-git-after-they-have-been-pushed
)
。
-
请注意每个commit的名称:应能反映当前commit的内容,不能太随意。
3)如果解决了某个Issue的问题,请在该PUll Request的
**第一个**
评论框中加上:
`fix #issue_number`
,这样当该PUll Request被合并后,会自动关闭对应的Issue。关键词包括:close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved,请选择合适的词汇。详细可参考
[
Closing issues via commit messages
](
https://help.github.com/articles/closing-issues-via-commit-messages
)
。
此外,在回复评审人意见时,请您遵守以下约定:
1)评审人的每个意见都必须回复(这是开源社区的基本礼貌,别人帮了忙,应该说谢谢):
-
对评审意见同意且按其修改完的,给个简单的
`Done`
即可;
-
对评审意见不同意的,请给出您自己的反驳理由。
2)如果评审意见比较多:
-
请给出总体的修改情况。
-
请采用
[
start a review
](
https://help.github.com/articles/reviewing-proposed-changes-in-a-pull-request/
)
进行回复,而非直接回复的方式。原因是每个回复都会发送一封邮件,会造成邮件灾难。
doc/fluid/advanced_usage/index.rst
浏览文件 @
5e42ecee
...
@@ -43,7 +43,7 @@
...
@@ -43,7 +43,7 @@
deploy/index_mobile.rst
deploy/index_mobile.rst
deploy/index_anakin.rst
deploy/index_anakin.rst
development/contribute_to_paddle
.md
development/contribute_to_paddle
/index_cn.rst
development/write_docs_cn.md
development/write_docs_cn.md
development/new_op.md
development/new_op.md
development/profiling/index.rst
development/profiling/index.rst
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录