本地开发指南

本文将指导您如何在本地进行代码开发

代码要求

  • 代码注释请遵守 golang 代码规范
  • 所有代码必须具有单元测试
  • 通过所有单元测试
  • 请遵循提交代码的一些约定

以下教程将指导您提交代码。

Fork

跳转到BFE GitHub首页，然后单击 Fork 按钮，生成自己目录下的仓库，比如 https://github.com/USERNAME/bfe

克隆（Clone）

将远程仓库 clone 到本地：

  1. $ git clone https://github.com/USERNAME/bfe
  2. $ cd bfe

创建本地分支

BFE目前使用Git流分支模型进行开发、测试、发行和维护，具体请参考 BFE分支规范。

所有的 feature 和 bug fix 的开发工作都应该在一个新的分支上完成，一般从 develop 分支上创建新分支。

使用 git checkout -b 创建并切换到新分支。

  1. $ git checkout -b my-cool-stuff

值得注意的是，在 checkout 之前，需要保持当前分支目录 clean，否则会把 untracked 的文件也带到新分支上，这可以通过 git status 查看。

安装工具集

make deps 一键安装所有依赖工具，包括 pre-commit goyacc license-eye staticcheck。

使用 pre-commit 钩子

BFE 开发人员使用 pre-commit 工具来管理 Git 预提交钩子。 它可以帮助我们格式化源代码，在提交（commit）前自动检查一些基本事宜（如每个文件只有一个 EOL，Git 中不要添加大文件等）。

pre-commit测试是 Travis-CI 中单元测试的一部分，不满足钩子的 PR 不能被提交到 BFE，首先安装并在当前目录运行它：

  1. # 确保安装pre-commit
  2. $ make deps
  3. # 开启自动更新以及安装钩子
  4. $ make precommit

BFE 使用 gofmt 来调整 golang源代码格式。

使用 license-eye 工具

license-eye 工具可以帮助我们检查和修复所有文件的证书声明，在提交 (commit) 前证书声明都应该先完成。

license-eye 检查是 Github-Action 中检测的一部分，检测不通过的 PR 不能被提交到 BFE，安装使用它：

  1. # 确保安装license-eye
  2. $ make deps
  3. # 检查所有许可证
  4. $ make license-check
  5. # 修复所有许可证
  6. $ make license-fix

开始开发

在本例中，我删除了 README.md 中的一行，并创建了一个新文件。

通过 git status 查看当前状态，这会提示当前目录的一些变化，同时也可以通过 git diff 查看文件具体被修改的内容。

  1. $ git status
  2. On branch test
  3. Changes not staged for commit:
  4.   (use "git add <file>..." to update what will be committed)
  5.   (use "git checkout -- <file>..." to discard changes in working directory)
  7.     modified:   README.md
  9. Untracked files:
  10.   (use "git add <file>..." to include in what will be committed)
  12.     test
  14. no changes added to commit (use "git add" and/or "git commit -a")

构建和测试

从源码编译BFE及测试，请参见编译及安装BFE

提交（commit）

接下来我们取消对 README.md 文件的改变，然后提交新添加的 test 文件。

  1. $ git checkout -- README.md
  2. $ git status
  3. On branch test
  4. Untracked files:
  5.   (use "git add <file>..." to include in what will be committed)
  7.     test
  9. nothing added to commit but untracked files present (use "git add" to track)
  10. $ git add test

Git 每次提交代码，都需要写提交说明，这可以让其他人知道这次提交做了哪些改变，这可以通过git commit 完成。

  1. $ git commit
  2. CRLF end-lines remover...............................(no files to check)Skipped
  3. yapf.................................................(no files to check)Skipped
  4. Check for added large files..............................................Passed
  5. Check for merge conflicts................................................Passed
  6. Check for broken symlinks................................................Passed
  7. Detect Private Key...................................(no files to check)Skipped
  8. Fix End of Files.....................................(no files to check)Skipped
  9. clang-formatter.......................................(no files to check)Skipped
  10. [my-cool-stuff c703c041] add test file
  11.  1 file changed, 0 insertions(+), 0 deletions(-)
  12.  create mode 100644 233

需要注意的是：您需要在commit中添加说明（commit message）以触发CI单测，写法如下：

  1. # 触发develop分支的CI单测
  2. $ git commit -m "test=develop"
  4. # 触发release/1.1分支的CI单测
  5. $ git commit -m "test=release/1.1"

保持本地仓库最新

在准备发起 Pull Request 之前，需要同步原仓库（https://github.com/bfenetworks/bfe）最新的代码。

首先通过 git remote 查看当前远程仓库的名字

  1. $ git remote
  2. origin
  3. $ git remote -v
  4. origin  https://github.com/USERNAME/bfe (fetch)
  5. origin  https://github.com/USERNAME/bfe (push)

这里 origin 是我们 clone 的远程仓库的名字，也就是自己用户名下的 BFE，接下来我们创建一个原始 BFE 仓库的远程主机，命名为 upstream。

  1. $ git remote add upstream https://github.com/bfenetworks/bfe
  2. $ git remote
  3. origin
  4. upstream

获取 upstream 的最新代码并更新当前分支。

  1. $ git fetch upstream
  2. $ git pull upstream develop

Push 到远程仓库

将本地的修改推送到 GitHub 上，也就是 https://github.com/USERNAME/bfe

  1. # 推送到远程仓库 origin 的 my-cool-stuff 分支上
  2. $ git push origin my-cool-stuff