Skip to content

Commit 437c15a

Browse files
author
livc
committed
pass pre-commit
1 parent 56b6ead commit 437c15a

File tree

1 file changed

+131
-91
lines changed

1 file changed

+131
-91
lines changed

‎doc/howto/dev/contribute_to_paddle_cn.md

Lines changed: 131 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,130 +1,170 @@
1-
# 如何贡献代码
2-
3-
我们真诚地感谢您的贡献，欢迎通过 GitHub 的 fork 和 pull request 流程来提交代码。
4-
5-
## 代码要求
6-
- 你的代码必须完全遵守 [doxygen](http://www.stack.nl/~dimitri/doxygen/) 的样式。
7-
- 确保编译器选项 WITH\_STYLE\_CHECK 已打开，并且编译能通过代码样式检查。
8-
- 所有代码必须具有单元测试。
9-
- 通过所有单元测试。
10-
11-
以下教程将指导您提交代码。
12-
13-
## [Fork](https://help.github.com/articles/fork-a-repo/)
14-
15-
跳转到[PaddlePaddle](https://github.com/PaddlePaddle/Paddle) GitHub首页，然后单击 `Fork` 按钮。
1+
# Git 开发指南
2+
3+
这个指南将完成一次完整的代码贡献流程。
4+
5+
## Fork
6+
7+
首先 Fork <https://github.com/PaddlePaddle/Paddle>，生成自己目录下的仓库，比如 <https://github.com/USERNAME/Paddle>。
168

179
## 克隆（Clone）
1810

19-
Paddle 目前使用[git流分支模型](http://nvie.com/posts/a-successful-git-branching-model/)进行开发，测试，发行和维护。
20-
**develop** 是主分支，其他用户分支是特征分支（feature branches）。
2111

22-
一旦你创建了一个fork，你可以使用你最喜欢的 git 客户端克隆你的仓库（repo）或只是直接在命令行输入：
2312

24-
```shell
25-
# 克隆 fork 到本地
26-
git clone --branch develop https://github.com/USERNAME/Paddle.git
27-
```
28-
如果你的仓库不包含 **develop** 分支，你只需自己创建它。
29-
30-
```shell
31-
git clone https://github.com/USERNAME/Paddle.git Paddle
32-
cd Paddle
33-
git checkout -b develop # 创建 develop 分支
34-
git remote add upstream https://github.com/PaddlePaddle/Paddle.git # 添加 upstream 到 baidu/Paddle
35-
git pull upstream develop # 更新 upstream
13+
## 创建本地分支
14+
15+
所有的 feature 和 bug_fix 的开发工作都应该在一个新的分支上完成，一般从 `develop` 分支上创建新分支。
16+
17+
```bash
18+
# （从当前分支）创建名为 MY_COOL_STUFF_BRANCH 的新分支
19+
➜ git branch MY_COOL_STUFF_BRANCH
20+
21+
# 切换到这个分支上
22+
➜ git checkout MY_COOL_STUFF_BRANCH
3623
```
3724

38-
然后你可以通过做一个本地开发分支开始开发
25+
也可以通过 `git checkout -b` 一次性创建并切换分支。
3926

40-
```shell
41-
git checkout -b MY_COOL_STUFF_BRANCH
27+
```bash
28+
➜ git checkout -b MY_COOL_STUFF_BRANCH
4229
```
4330

44-
## 使用 `pre-commit` 钩子
31+
值得注意的是，在 checkout 之前，需要保持当前分支目录 clean，否则会把 untracked 的文件也带到新分支上，这可以通过 `git status` 查看。
32+
33+
## 开始开发
4534

46-
Paddle 开发人员使用 [pre-commit](http://pre-commit.com/) 工具来管理git预提交钩子。 它可以帮助我们格式化源代码（cpp，python），在提交前检查一些基本事宜（每个文件只有一个 EOL
47-
，git 中不要添加大文件）。 `pre-commit`测试是 Travis-CI 中单元测试的一部分，不满足钩子
48-
的 PR 不能提交代码到 Paddle。
35+
在本例中，我删除了 README.md 中的一行，并创建了一个新文件。
4936

50-
你可以通过 `pip install pre-commit` 安装 [pre-commit](http://pre-commit.com/)，
51-
目前 Paddle 使用 `clang-format` 来调整C/C++源代码格式。请确保 clang-format 版本在3.8以上。
37+
通过 `git status` 查看当前状态，这会提示当前目录的一些变化，同时也可以通过 `git diff` 查看文件具体被修改的内容。
5238

53-
然后只需在 Paddle clone 目录中运行 `pre-commit install` 。当你
54-
提交你的代码时，pre-commit 钩子会检查本地代码是否存在
55-
不适合提交的东西，等等。
39+
```bash
40+
➜ git status
41+
On branch test
42+
Changes not staged for commit:
43+
(use "git add <file>..." to update what will be committed)
44+
(use "git checkout -- <file>..." to discard changes in working directory)
5645

57-
## 提交（Commit）
46+
modified: README.md
5847

59-
提交你的代码：
48+
Untracked files:
49+
(use "git add <file>..." to include in what will be committed)
6050

61-
```shell
62-
# 显示工作树状态
63-
git status
64-
# 添加修改过的文件
65-
git add xx
66-
env EDITOR=vim git commit # 你可以用 vim/nano/emacs 写下你的注释
51+
test
52+
53+
no changes added to commit (use "git add" and/or "git commit -a")
6754
```
68-
提交信息的第一行是标题，其他行可以添加一些细节（如果有必要的话）。
6955

70-
## 保持 Fork 状态最新
56+
## 提交（commit）
57+
58+
接下来我们取消对 README.md 文件的改变，然后提交新添加的 test 文件。
7159

72-
在拉（pull）你的请求（request）之前，你应该从最新的 PaddlePaddle 同步代码。
73-
为此，你需要首先添加远程（remote）：
60+
```bash
61+
➜ git checkout -- README.md
62+
➜ git status
63+
On branch test
64+
Untracked files:
65+
(use "git add <file>..." to include in what will be committed)
7466

75-
```shell
76-
# 观察当前远程仓库配置
77-
git remote -v
78-
# 添加上游（upstream）仓库
79-
git remote add upstream https://github.com/PaddlePaddle/Paddle.git
80-
# 验证新的 upstream
81-
git remote -v
67+
test
68+
69+
nothing added to commit but untracked files present (use "git add" to track)
70+
➜ git add test
8271
```
8372

84-
用最新的 upstream 更新你的 fork：
73+
Paddle 使用 [pre-commit](http://pre-commit.com) 完成代码风格检查的自动化，它会在每次 commit 时自动检查代码是否符合规范，并检查一些基本事宜，因此我们首先安装并在当前目录运行它。
8574

86-
```shell
87-
git pull --rebase upstream develop
75+
```bash
76+
➜ pip install pre-commit
77+
➜ pre-commit install
8878
```
89-
如果本地没有提交，git 将简单地执行快进。但是，如果你一直在做一些改变（绝大多数情况下不应该），你可能要处理冲突。
9079

91-
现在，你的本地主分支与上游修改的一致并是最新的。
80+
Git 每次提交代码，都需要写提交说明，这可以让其他人知道这次提交做了哪些改变，这可以通过`git commit -m` 完成。
81+
82+
```bash
83+
➜ git commit -m "add test file"
84+
CRLF end-lines remover...............................(no files to check)Skipped
85+
yapf.................................................(no files to check)Skipped
86+
Check for added large files..............................................Passed
87+
Check for merge conflicts................................................Passed
88+
Check for broken symlinks................................................Passed
89+
Detect Private Key...................................(no files to check)Skipped
90+
Fix End of Files.....................................(no files to check)Skipped
91+
clang-formater.......................................(no files to check)Skipped
92+
[MY_COOL_STUFF_BRANCH c703c041] add test file
93+
1 file changed, 0 insertions(+), 0 deletions(-)
94+
create mode 100644 233
95+
```
96+
97+
## 保持本地仓库最新
98+
99+
在准备发起 Pull Request 之前，需要同步原仓库（<https://github.com/PaddlePaddle/Paddle>）最新的代码。
100+
101+
首先通过 `git remote` 查看当前远程仓库的名字。
92102

93-
## 推送（Push）到 GitHub
103+
```bash
104+
➜ git remote
105+
origin
106+
➜ git remote -v
107+
origin https://github.com/USERNAME/Paddle (fetch)
108+
origin https://github.com/USERNAME/Paddle (push)
109+
```
110+
111+
这里 origin 是我们 clone 的远程仓库的名字，也就是自己用户名下的 Paddle，接下来我们创建一个原始 Paddle 仓库的远程主机，命名为 upstream。
94112

95-
```shell
96-
# 在 GitHub 上 push 你的仓库
97-
git push -u origin MY_COOL_STUFF_BRANCH # 创建远程分支 MY_COOL_STUFF_BRANCH 到 origin.
113+
```bash
114+
➜ git remote add upstream https://github.com/PaddlePaddle/Paddle
115+
➜ git remote
116+
origin
117+
upstream
98118
```
99119

100-
## 拉取请求（Pull Request）
120+
获取 upstream 的最新代码并更新当前分支。
101121

102-
转到 GitHub上 你 fork 的页面，选择你的开发分支并单击 **pull request 按钮**。
122+
```bash
123+
➜ git fetch upstream
124+
➜ git pull --rebase upstream develop
125+
```
103126

104-
## 使用最新版本更新你的 pull 请求
127+
## Push 到远程仓库
105128

106-
在代码审查（code review）期间，由于 baidu/Paddle 中新的提交导致你的 pull 请求可能会失效。如果没有冲突，GitHub允许自动更新。 你可以点击 pull request 页面中的“更新分支（Update Branch）”按钮。 但是如果存在代码冲突，你需要手动进行更新。你需要在本地仓库执行如下命令：
129+
将本地的修改推送到 GitHub 上，也就是 https://github.com/USERNAME/Paddle。
107130

108-
```shell
109-
git checkout MY_COOL_STUFF_BRANCH
110-
git pull upstream develop
111-
# 你可能需要根据git提示解决冲突
112-
# 创建并测试你的代码
113-
git push origin MY_COOL_STUFF_BRANCH
131+
```bash
132+
# 推送到远程仓库 origin 的 MY_COOL_STUFF_BRANCH 分支上
133+
➜ git push origin MY_COOL_STUFF_BRANCH
114134
```
115-
现在你的 Pull Request 是最新的了。
116135

117-
## 修改你的 pull request
136+
## 建立 Issue 并完成 PR
137+
138+
建立一个 Issue 描述问题，记录它的编号。
139+
140+
在 Push 新分支后， https://github.com/USERNAME/Paddle 中会出现新分支提示，点击绿色按钮发起 PR。
141+
142+
![](https://ws1.sinaimg.cn/large/9cd77f2egy1fez1jq9mwdj21js04yq3m.jpg)
143+
144+
选择目标分支：
145+
146+
![](https://ws1.sinaimg.cn/large/9cd77f2egy1fez1ku4a5vj21am04st9l.jpg)
118147

119-
当根据审阅者的意见修改 pull 请求时，请使用“git commit”而不是“git commit --amend”来提交更改，以便审阅者可以看到新的请求和旧的请求之间的区别。
148+
在 PR 的说明中，填写 `solve #Issue编号` 可以在这个 PR 被 merge 后，自动关闭对应的 Issue，具体请见 <https://help.github.com/articles/closing-issues-via-commit-messages/>。
120149

121-
可能的命令是
150+
接下来等待 review，如果有需要修改的地方，参照上述步骤更新 origin 中的对应分支即可。
122151

123-
```shell
124-
git checkout MY_COOL_STUFF_BRANCH
125-
git pull upstream develop # 将本地更新到最新的代码库
126-
# 可能会发生一些冲突
127-
# 开始开发吧！
128-
env EDITOR=vim git commit # 添加修改日志
129-
git push origin MY_COOL_STUFF_BRANCH
152+
## 删除远程分支
153+
154+
在 PR 被 merge 进主仓库后，我们可以在 PR 的页面删除远程仓库的分支。
155+
156+
![](https://ws1.sinaimg.cn/large/9cd77f2egy1fez1pkqohzj217q05c0tk.jpg)
157+
158+
## 删除本地分支
159+
160+
最后，删除本地分支。
161+
162+
```bash
163+
# 切换到 develop 分支
164+
git checkout develop
165+
166+
# 删除 MY_COOL_STUFF_BRANCH 分支
167+
git branch -D MY_COOL_STUFF_BRANCH
130168
```
169+
170+
至此，我们就完成了一次代码贡献的过程。

0 commit comments

Comments
 (0)