-
Notifications
You must be signed in to change notification settings - Fork 5.8k
add contribute_to_paddle_cn.md #882
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
等 #874 merge了之后,再对应修改一下吧。 |
OK |
doc/howto/contribute_to_paddle_cn.md
Outdated
@@ -0,0 +1,119 @@ | |||
# 如何贡献代码 | |||
|
|||
我们真诚地感谢您的贡献。你能使用 fork 和 pull request 的工作流来合并(merge)代码。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
你能使用 fork 和 pull request 的工作流来合并(merge)代码。
->
欢迎通过 GitHub 的 fork 和 pull request 流程来提交代码。
doc/howto/contribute_to_paddle_cn.md
Outdated
|
||
## 代码要求 | ||
- 你的代码必须完全遵守 [doxygen](http://www.stack.nl/~dimitri/doxygen/) 的样式。 | ||
- 确保编译器选项 WITH\_STYLE\_CHECK 已打开,并且编译器通过代码样式检查。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
确保编译器选项 WITH_STYLE_CHECK 已打开,并且编译能通过代码样式检查。
doc/howto/contribute_to_paddle_cn.md
Outdated
## [Fork](https://help.github.com/articles/fork-a-repo/) | ||
|
||
转到GitHub页面,然后单击“Fork”按钮。 | ||
这就是这么简单。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
转到GitHub页面,然后单击“Fork”按钮。
-》
跳转到PaddlePaddle GitHub首页,然后单击 Fork
按钮。
这就是这么简单。 -》 这句删除,不要了
doc/howto/contribute_to_paddle_cn.md
Outdated
|
||
## 克隆(Clone) | ||
|
||
Paddle 目前使用[git流分支模型](http://nvie.com/posts/a-successful-git-branching-model/)。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Paddle 目前使用[git流分支模型](http://nvie.com/posts/a-successful-git-branching-model/)进行开发,测试,发行和维护。
doc/howto/contribute_to_paddle_cn.md
Outdated
@@ -0,0 +1,131 @@ | |||
# 如何贡献代码 | |||
|
|||
我们真诚地感谢您的贡献,欢迎通过 GitHub 的 fork 和 pull request 流程来提交代码。。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
。。-》 。
doc/howto/contribute_to_paddle_cn.md
Outdated
的 PR 不能提交代码到 Paddle。 | ||
|
||
你可以通过 `pip install pre-commit` 安装 [pre-commit](http://pre-commit.com/), | ||
目前 Paddle 使用 `clang-format` 来格式化 c/cpp 资源。请确保 clang-format 版本在3.8以上。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
目前 Paddle 使用 `clang-format` 来调整C/C++源代码格式。
doc/howto/contribute_to_paddle_cn.md
Outdated
|
||
## 使用最新版本更新你的 pull 请求 | ||
|
||
在代码审查(code review)期间,由于 baidu/Paddle 中新的提交导致你的 pull 请求可能会失效。如果没有冲突,GitHub允许自动更新。 你可以点击 pull request 页面中的“更新分支(Update Branch)”按钮。 但是在这种冲突情况下,你需要手动进行更新。你需要在本地仓库执行如下命令: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
但是如果存在代码冲突,你需要手动进行更新。
doc/howto/contribute_to_paddle_cn.md
Outdated
```shell | ||
git pull --rebase upstream develop | ||
``` | ||
如果本地没有唯一提交,git 将简单地执行快进。但是,如果你一直在做一些改变(绝大多数情况下不应该),你可能要处理冲突。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
唯一 -》 删除,不要了
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice job! Please follow my feedback to change several words and sentences.
Hi, @livc Thanks for your continuous contribution. |
@gangliao You're welcome! : ) |
* modified lrn formula * modified design idea * Update fluid_design_idea.md * Update fluid_design_idea.md
Co-authored-by: smallv0221 <[email protected]>
resolve #835 contribute_to_paddle.
Thanks.