CONTRIBUTING.md

Contribute Code

You are welcome to contribute to project BFE. This document explains our workflow and work style.

Workflow

BFE uses this Git branching model. The following steps guide usual contributions.

1. Fork

   Our development community has been growing fastly; it doesn't make sense for everyone to write into the official repo. So, please file Pull Requests from your fork. To make a fork, just head over to the GitHub page and click the "Fork" button.

2. Clone

   To make a copy of your fork to your local computers, please run

   git clone https://github.com/your-github-account/bfe
   cd bfe

3. Create the local feature branch

   For daily works like adding a new feature or fixing a bug, please open your feature branch before coding:

   git checkout -b my-cool-stuff

4. Commit

   Before issuing your first git commit command, please install pre-commit by running the following commands:

   pip install pre-commit
   pre-commit install

   Our pre-commit configuration requires gofmt for auto-formating golang code.

   Once installed, pre-commit checks the style of code and documentation in every commit:

   $ git commit -s
   

   NOTE: You should add a line to every git commit message, e.g.

   Signed-off-by: Sijie Yang <[email protected]>
   

   Please use your real name (sorry, no pseudonyms or anonymous contributions). The signoff line at the end of the commit message certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the Developer Certificate of Origin.

   NOTE: The yapf installed by pip install pre-commit and conda install -c conda-forge pre-commit is slightly different. BFE developers use pip install pre-commit.

5. Build and test

   Users can build BFE natively on Linux.

   make

6. Keep pulling

   An experienced Git user pulls from the official repo often -- daily or even hourly, so they notice conflicts with others work early, and it's easier to resolve smaller conflicts.

   git remote add upstream https://github.com/bfenetworks/bfe
   git pull upstream develop

7. Push and file a pull request

   You can "push" your local work into your forked repo:

   git push origin my-cool-stuff

   The push allows you to create a pull request, requesting owners of this official repo to pull your change into the official one.

   To create a pull request, please follow these steps.

   If your change is for fixing an issue, please write "Fixes " in the description section of your pull request. Github would close the issue when the owners merge your pull request.

   Please remember to specify some reviewers for your pull request. If you don't know who are the right ones, please follow Github's recommendation.

8. Delete local and remote branches

   To keep your local workspace and your fork clean, you might want to remove merged branches:

   git push origin :my-cool-stuff
   git checkout develop
   git pull upstream develop
   git branch -d my-cool-stuff

Code Review

• Please feel free to ping your reviewers by sending them the URL of your pull request via IM or email. Please do this after your pull request passes the CI.

• Please answer reviewers' every comment. If you are to follow the comment, please write "Done"; please give a reason otherwise.

• If you don't want your reviewers to get overwhelmed by email notifications, you might reply their comments by in a batch.

• Reduce the unnecessary commits. Some developers commit often. It is recommended to append a sequence of small changes into one commit by running git commit --amend instead of git commit.

Coding Standard

Code Style

Our Golang code follows the Golang style guide.

Our build process helps to check the code style.

Please install pre-commit, which automatically reformat the changes to Golang code whenever we run git commit.

Unit Tests

Please remember to add related unit tests.

• For Golang code, please use Golang's standard testing package.