Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
PaddlePaddle
Paddle
提交
9bc04baa
P
Paddle
项目概览
PaddlePaddle
/
Paddle
大约 1 年 前同步成功
通知
2298
Star
20931
Fork
5422
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
1423
列表
看板
标记
里程碑
合并请求
543
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
P
Paddle
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
1,423
Issue
1,423
列表
看板
标记
里程碑
合并请求
543
合并请求
543
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
9bc04baa
编写于
12月 14, 2016
作者:
L
livc
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add contribute_to_paddle_cn.md
上级
140edd24
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
119 addition
and
0 deletion
+119
-0
doc/howto/contribute_to_paddle_cn.md
doc/howto/contribute_to_paddle_cn.md
+119
-0
未找到文件。
doc/howto/contribute_to_paddle_cn.md
0 → 100644
浏览文件 @
9bc04baa
# 如何贡献代码
我们真诚地感谢您的贡献。你能使用 fork 和 pull request 的工作流来合并(merge)代码。
## 代码要求
-
你的代码必须完全遵守
[
doxygen
](
http://www.stack.nl/~dimitri/doxygen/
)
的样式。
-
确保编译器选项 WITH
\_
STYLE
\_
CHECK 已打开,并且编译器通过代码样式检查。
-
所有代码必须具有单元测试。
-
通过所有单元测试。
以下教程将指导您提交代码。
## [Fork](https://help.github.com/articles/fork-a-repo/)
转到GitHub页面,然后单击“Fork”按钮。
这就是这么简单。
## 克隆(Clone)
Paddle 目前使用
[
git流分支模型
](
http://nvie.com/posts/a-successful-git-branching-model/
)
。
**develop**
是主分支,其他用户分支是特征分支(feature branches)。
一旦你创建了一个fork,你可以使用你最喜欢的 git 客户端克隆你的仓库(repo)或只是直接在命令行输入:
```
shell
# 克隆 fork 到本地
git clone
--branch
develop https://github.com/USERNAME/Paddle.git
```
如果你的仓库不包含
**develop**
分支,你只需自己创建它。
```
shell
git clone https://github.com/USERNAME/Paddle.git Paddle
cd
Paddle
git checkout
-b
develop
# 创建 develop 分支
git remote add upstream https://github.com/PaddlePaddle/Paddle.git
# 添加 upstream 到 baidu/Paddle
git pull upstream develop
# 更新 upstream
git submodule update
--init
--recursive
```
然后你可以通过做一个本地开发分支开始开发
```
shell
git checkout
-b
MY_COOL_STUFF_BRANCH
```
## 提交(Commit)
提交你的代码:
```
shell
# 显示工作树状态
git status
# 添加修改过的文件
git add xx
env
EDITOR
=
vim git commit
# 你可以用 vim/nano/emacs 写下你的注释
```
提交信息的第一行是标题,其他行可以添加一些细节(如果有必要的话)。
## 保持 Fork 状态最新
在拉(pull)你的请求(request)之前,你应该从最新的 PaddlePaddle 同步代码。
为此,你需要首先添加远程(remote):
```
shell
# 观察当前远程仓库配置
git remote
-v
# 添加上游(upstream)仓库
git remote add upstream https://github.com/PaddlePaddle/Paddle.git
# 验证新的 upstream
git remote
-v
```
用最新的 upstream 更新你的 fork:
```
shell
git pull
--rebase
upstream develop
```
如果本地没有唯一提交,git 将简单地执行快进。但是,如果你一直在做一些改变(绝大多数情况下不应该),你可能要处理冲突。
现在,你的本地主分支与上游修改的一致并是最新的。
## 推送(Push)到 GitHub
```
shell
# 在 GitHub 上 push 你的仓库
git push
-u
origin MY_COOL_STUFF_BRANCH
# 创建远程分支 MY_COOL_STUFF_BRANCH 到 origin.
```
## 拉取请求(Pull Request)
转到 GitHub上 你 fork 的页面,选择你的开发分支并单击
**pull request 按钮**
。
## 使用最新版本更新你的 pull 请求
在代码审查(code review)期间,由于 baidu/Paddle 中新的提交导致你的 pull 请求可能会失效。如果没有冲突,GitHub允许自动更新。 你可以点击 pull request 页面中的“更新分支(Update Branch)”按钮。 但是在这种冲突情况下,你需要手动进行更新。你需要在本地仓库执行如下命令:
```
shell
git checkout MY_COOL_STUFF_BRANCH
git pull upstream develop
# 你可能需要根据git提示解决冲突
# 创建并测试你的代码
git push origin MY_COOL_STUFF_BRANCH
```
现在你的 Pull Request 是最新的了。
## 修改你的 pull request
当根据审阅者的意见修改 pull 请求时,请使用“git commit”而不是“git commit --amend”来提交更改,以便审阅者可以看到新的请求和旧的请求之间的区别。
可能的命令是
```
shell
git checkout MY_COOL_STUFF_BRANCH
git pull upstream develop
# 将本地更新到最新的代码库
# 可能会发生一些冲突
# 开始开发吧!
env
EDITOR
=
vim git commit
# 添加修改日志
git push origin MY_COOL_STUFF_BRANCH
```
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录