CONTRIBUTING.md

English / 中文

Contributing and Review Guidelines

All contributions are welcome!

Branching

Our branching method is git-flow

• master: Latest stable branch
• dev: Stable branch waiting for release(merge to master)
• feature-xxxx: A developing branch of a new feature named xxxx
• bugfix-xxxx: A branch to fix the bug named xxxx

How to

Issue

Go to issues page

Fix bugs

1. Fork this repo
2. Create a new branch named bugfix-xxxx forked from your repo's master branch
3. Fix the bug
4. Test the fixed code
5. Make pull request back to this repo's dev branch
6. Wait the community to review the code
7. Merged(Bug fixed)

Develop a new feature

1. Fork this repo
2. Create a new branch named feature-xxxx forked from your repo's dev branch
3. Coding in feature-xxxx
4. Pull this repo's dev branch to your feature-xxxx constantly
5. Test your code
6. Make pull request back to this repo's dev branch
7. Wait the community to review the code
8. Merged !!!!

Coding Style

See CODING_STYLE.

Code formatting

Code formatting rules are described by the Clang-Format Style Options file .clang-format. Please use the clang-format (version 5.0 or higher recommended) tool to format your code changes accordingly. git-clang-format tool is useful to limit reformatting to your changes only:

git clang-format          # to reformat the changes in the staging area and put the result into working directory
git clang-format -f       # to reformat the changes in the working directory
git clang-format <commit> # to reformat commits between specified commit and HEAD

Continous integration

Continous integration platform

• travis-ci: (check unitest)

• circleci: (check static complie and guomi version)

Coverage

• codecov:

Code quality

• CodeFactor:

• Codacy: