Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
PaddlePaddle
Paddle
提交
ad6e3915
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看板
提交
ad6e3915
编写于
12月 15, 2016
作者:
L
livc
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
modify details and add 'pre-commit'
上级
9bc04baa
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
17 addition
and
5 deletion
+17
-5
doc/howto/contribute_to_paddle_cn.md
doc/howto/contribute_to_paddle_cn.md
+17
-5
未找到文件。
doc/howto/contribute_to_paddle_cn.md
浏览文件 @
ad6e3915
# 如何贡献代码
我们真诚地感谢您的贡献
。你能使用 fork 和 pull request 的工作流来合并(merge)代码
。
我们真诚地感谢您的贡献
,欢迎通过 GitHub 的 fork 和 pull request 流程来提交代码。
。
## 代码要求
-
你的代码必须完全遵守
[
doxygen
](
http://www.stack.nl/~dimitri/doxygen/
)
的样式。
-
确保编译器选项 WITH
\_
STYLE
\_
CHECK 已打开,并且编译
器
通过代码样式检查。
-
确保编译器选项 WITH
\_
STYLE
\_
CHECK 已打开,并且编译
能
通过代码样式检查。
-
所有代码必须具有单元测试。
-
通过所有单元测试。
...
...
@@ -12,12 +12,11 @@
## [Fork](https://help.github.com/articles/fork-a-repo/)
转到GitHub页面,然后单击“Fork”按钮。
这就是这么简单。
跳转到
[
PaddlePaddle
](
https://github.com/PaddlePaddle/Paddle
)
GitHub首页,然后单击
`Fork`
按钮。
## 克隆(Clone)
Paddle 目前使用
[
git流分支模型
](
http://nvie.com/posts/a-successful-git-branching-model/
)
。
Paddle 目前使用
[
git流分支模型
](
http://nvie.com/posts/a-successful-git-branching-model/
)
进行开发,测试,发行和维护
。
**develop**
是主分支,其他用户分支是特征分支(feature branches)。
一旦你创建了一个fork,你可以使用你最喜欢的 git 客户端克隆你的仓库(repo)或只是直接在命令行输入:
...
...
@@ -43,6 +42,19 @@ git submodule update --init --recursive
git checkout
-b
MY_COOL_STUFF_BRANCH
```
## 使用 `pre-commit` 钩子
Paddle 开发人员使用
[
pre-commit
](
http://pre-commit.com/
)
工具来管理git预提交钩子。 它可以帮助我们格式化源代码(cpp,python),在提交前检查一些基本事宜(每个文件只有一个 EOL
,git 中不要添加大文件)。
`pre-commit`
测试是 Travis-CI 中单元测试的一部分,不满足钩子
的 PR 不能提交代码到 Paddle。
你可以通过
`pip install pre-commit`
安装
[
pre-commit
](
http://pre-commit.com/
)
,
目前 Paddle 使用
`clang-format`
来格式化 c/cpp 资源。请确保 clang-format 版本在3.8以上。
然后只需在 Paddle clone 目录中运行
`pre-commit install`
。当你
提交你的代码时,pre-commit 钩子会检查本地代码是否存在
不适合提交的东西,等等。
## 提交(Commit)
提交你的代码:
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录