Guide of submitting PR to Github

    Switch to the branch you have created and click .

    Switch to targeted branch. A note of resolve #Issue number in PR description results in automatic close of corresponding Issue after the merge of PR. More details can be viewed here.

    Then please wait for review. If there is any need to make a modification, you can update corresponding branch in origin following the steps above.

    Every new commit in your Pull Request will trigger CI unit tests, so please make sure that necessary comments have been included in your commit message. Please refer to

    Please note the procedure of CI unit tests in your Pull Request which will be finished in several hours.

    You only need to focus on CI projects associated with your submitted branch. For example, there is no need to check whether release/1.1 pass test or not if you submit code to develop branch.

    Green ticks after all tests means that your commit has passed all unit tests.

    We can delete branches of remote repository in PR page after your PR is successfully merged into master repository.

    We can also delete the branch of remote repository with , such as:

    Finally,we delete local branch

    1. $ git checkout develop # switch to develop branch

    And now we finish a full process of code contribution

    In order that reviewers focus on code in the code review, please follow these rules every time you submit your code:

    1）Make sure that unit tests in Travis-CI pass through successfully.If it fails,it means problems have been found in submitted code which will not be reviewed by reviewer.

    2）Before the submit of PUll Request:

    Suggestion：Keep commit concise as much as possible at every submit. You can make a supplyment to the previous commit with git commit --amend. About several commits having been pushed to remote repository, you can refer to squash commits after push。

    • Pay attention to the name of every commit: It would be better to abstract the content of present commit and be not too arbitrary.

    3）If you have tackled with problems of an Issue, please add to the first comment area of PULL Request.Then the corresponding Issue will be closed automatically after the merge of PULL Request. Keywords are including:close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved. Please select appropriate word. Please refer to for more details.

    In addition, please follow the following regulations in response to the suggestion of reviewers:

    1）A reply to every comment of reviewers（It’s a fundamental complimentary conduct in open source community.An expression of appreciation is a need for help from others):

    • If you adopt the suggestion of reviewer and make a modification accordingly, it’s courteous to reply with a simple Done .

    • Please clarify your reason to the disagreenment

    2）If there are many suggestions

    • Please follow start a review to give your reply,instead of directly replying for that every comment will result in sending an email causing email disaster.