-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enrich guidence for code contribution
Signed-off-by: zhugelianglongming <zhugelianglongming@163.com>
- Loading branch information
1 parent
4254cf7
commit 8a51baa
Showing
1 changed file
with
167 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,182 @@ | ||
# 如何贡献代码 | ||
本文将指导您如何进行代码开发 | ||
|
||
## 代码要求 | ||
- 代码注释请遵守 golang 代码规范 | ||
- 所有代码必须具有单元测试 | ||
- 通过所有单元测试 | ||
- 请遵循提交代码的[一些约定](https://www.bfe-networks.net/zh_cn/development/submit_pr_guide/) | ||
- 请遵循提交代码的[一些约定][submit PR guide] | ||
|
||
## 代码开发流程 | ||
1. Fork | ||
以下教程将指导您提交代码 | ||
|
||
1. [Fork](https://help.github.com/articles/fork-a-repo/) | ||
|
||
跳转到[BFE Ingress Github][]首页,然后单击 `Fork` 按钮,生成自己目录下的远程仓库。 | ||
> 如 `https://github.com/${USERNAME}/ingress-bfe` | ||
1. 克隆(Clone) | ||
|
||
将自己目录下的远程仓库 clone 到本地: | ||
```bash | ||
$ git clone https://github.com/${USERNAME}/ingress-bfe | ||
$ cd ingress-bfe | ||
``` | ||
|
||
1. 创建本地分支 | ||
|
||
我们目前使用[Git流分支模型][]进行开发、测试、发行和维护,具体请参考 [分支规范][]。 | ||
* 所有的 feature 和 bug fix 的开发工作都应该在一个新的分支上完成 | ||
* 一般从 `develop` 分支上创建新分支。 | ||
|
||
使用 `git checkout -b` 创建并切换到新分支。 | ||
```bash | ||
$ git checkout -b my-cool-stuff | ||
``` | ||
|
||
> 值得注意的是,在 checkout 之前,需要保持当前分支目录 clean, | ||
否则会把 untracked 的文件也带到新分支上,这可以通过 `git status` 查看。 | ||
|
||
1. 使用 pre-commit 钩子 | ||
|
||
我们使用 [pre-commit][] 工具来管理 Git 预提交钩子。 | ||
它可以帮助我们格式化源代码,在提交(commit)前自动检查一些基本事宜。 | ||
> 如每个文件只有一个 EOL,Git 中不要添加大文件等 | ||
|
||
pre-commit 测试是 Travis-CI 中单元测试的一部分,不满足钩子的 PR 不能被提交到代码库。 | ||
|
||
1. 安装并在当前目录运行 pre-commit: | ||
```bash | ||
$ pip install pre-commit | ||
$ pre-commit install | ||
``` | ||
1. 使用 `gofmt` 来调整 golang源代码格式。 | ||
|
||
1. 编写代码 | ||
|
||
在本例中,删除了 README.md 中的一行,并创建了一个新文件。 | ||
|
||
通过 `git status` 查看当前状态,这会提示当前目录的一些变化,同时也可以通过 `git diff` 查看文件具体被修改的内容。 | ||
|
||
```bash | ||
$ git status | ||
On branch test | ||
Changes not staged for commit: | ||
(use "git add <file>..." to update what will be committed) | ||
(use "git checkout -- <file>..." to discard changes in working directory) | ||
modified: README.md | ||
Untracked files: | ||
(use "git add <file>..." to include in what will be committed) | ||
test | ||
no changes added to commit (use "git add" and/or "git commit -a") | ||
``` | ||
|
||
1. 构建和测试 | ||
|
||
从源码编译 BFE Ingress docker 并测试,请参见 [Ingress 部署指南](../deployment.md) | ||
|
||
1. 提交(commit) | ||
|
||
接下来我们取消对 README.md 文件的改变,然后提交新添加的 test 文件。 | ||
|
||
```bash | ||
$ git checkout -- README.md | ||
$ git status | ||
On branch test | ||
Untracked files: | ||
(use "git add <file>..." to include in what will be committed) | ||
test | ||
nothing added to commit but untracked files present (use "git add" to track) | ||
$ git add test | ||
``` | ||
|
||
Git 每次提交代码,都需要写提交说明,这可以让其他人知道这次提交做了哪些改变,这可以通过`git commit` 完成。 | ||
|
||
```bash | ||
$ git commit | ||
CRLF end-lines remover.............................(no files to check)Skipped | ||
yapf...............................................(no files to check)Skipped | ||
Check for added large files............................................Passed | ||
Check for merge conflicts..............................................Passed | ||
Check for broken symlinks..............................................Passed | ||
Detect Private Key.................................(no files to check)Skipped | ||
Fix End of Files...................................(no files to check)Skipped | ||
clang-formater.....................................(no files to check)Skipped | ||
[my-cool-stuff c703c041] add test file | ||
1 file changed, 0 insertions(+), 0 deletions(-) | ||
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" | ||
``` | ||
|
||
1. 保持本地仓库最新 | ||
|
||
在准备发起 Pull Request 之前,需要同步 [BFE Ingress Github][] 最新的代码。 | ||
|
||
首先通过 [git remote][] 查看当前远程仓库的名字 | ||
|
||
```bash | ||
$ git remote | ||
origin | ||
$ git remote -v | ||
origin https://github.com/${USERNAME}/ingress-bfe (fetch) | ||
origin https://github.com/${USERNAME}/ingress-bfe (push) | ||
``` | ||
|
||
这里`origin`是远程仓库名,引用了自己目录下的远程 ingress-bfe 仓库。 | ||
|
||
接下来我们创建一个命名为`upstream`的远程仓库名,引用[原始 ingress-bfe 仓库][BFE Ingress Github]。 | ||
|
||
```bash | ||
$ git remote add upstream https://github.com/bfenetworks/ingress-bfe | ||
$ git remote | ||
origin | ||
upstream | ||
``` | ||
|
||
获取 upstream 的最新代码并更新当前分支。 | ||
|
||
```bash | ||
$ git fetch upstream | ||
$ git pull upstream develop | ||
``` | ||
1. Push 到远程仓库 | ||
|
||
> 可参考 BFE [开发流程](https://www.bfe-networks.net/zh_cn/development/local_dev_guide/) | ||
将本地的修改推送到 GitHub `https://github.com/${USERNAME}/ingress-bfe` | ||
|
||
```bash | ||
# 推送到远程仓库 origin 的 my-cool-stuff 分支上 | ||
$ git push origin my-cool-stuff | ||
``` | ||
|
||
> 可参考 BFE [开发流程](https://www.bfe-networks.net/zh_cn/development/local_dev_guide/) | ||
|
||
## PR 提交流程 | ||
|
||
1. 建立 Issue 并完成 Pull Request | ||
1. 通过单元测试 | ||
1. 删除远程分支 | ||
1. 删除本地分支 | ||
|
||
> 可参考 BFE [提交PR注意事项][submit PR guide] | ||
|
||
[BFE Ingress Github]: https://github.com/bfenetworks/ingress-bfe | ||
[Git流分支模型]: http://nvie.com/posts/a-successful-git-branching-model/ | ||
[分支规范]: https://github.com/bfenetworks/bfe/blob/develop/docs/zh_cn/development/release_regulation.md | ||
[pre-commit]: http://pre-commit.com/ | ||
[git remote]: https://git-scm.com/docs/git-remote | ||
[submit PR guide]: https://www.bfe-networks.net/zh_cn/development/submit_pr_guide/ |