You need a Gitlab account on our server to contribute.
- Request for account.
- Once account is activated, you will be sent a link to set password.
- Add SSH key. You will not be allowed to pull or push without uploading a key.
How to Report Bug or Suggest Improvement
- Create issue describing bug, documentation error or suggested improvement.
- In the first line of the issue description, add "@chen.song" to alert project maintainer.
How to Start Development
If you want to do your own development on the project, follow the instructions below.
Note: It is important to copy the repository by forking. You will not be allowed to push changes/branches to the original repository.
- Fork repository.
- Clone your forked repository.
git clone <fork_url>
- Add upstream link to be able to update your forked repository.
git remote add upstream <original_url>
- Create branch for development. Commit often but meaningfully, e.g. after running unit tests.
git checkout -b <branch_name> ... git status git add/rm ... git commit ... ... git push origin <branch_name>
- Regularly update your forked repository and pull changes to working branch.
git checkout master git merge upstream/master git push origin master git fetch origin git checkout <branch_name> git rebase origin/master
How to Submit Contribution
- Make sure an issue exists that directly corresponds to the bugfix/feature you would like to contribute.
If there is none, please create one (see above "How to report bug or suggest improvement").
Create merge request. Select your working branch as source and the original repository's master as target.
Use prefix "WIP:" in the title to signify this is a work in progress.
- In the first lines of the issue description, add either "Closes #IssueId" and/or "Related #IssueId1, #IssueId2" to link related issues to your merge request.
- The project team will discuss whether the merge request will be included in the official release.
- If the merge request is accepted, please address any question/request from the project team.