|
|
|
**Account Creation**
|
|
|
|
### Account Creation
|
|
|
|
You need a Gitlab account on our server to contribute.
|
|
|
|
1. [Request](/How to Contribute/Request Gitlab Account) for account.
|
|
|
|
2. Once account is activated, you will be sent a link to set password.
|
|
|
|
3. [Add](https://docs.gitlab.com/ce/ssh/README.html#generating-a-new-ssh-key-pair) SSH key. You will not be allowed to pull or push without uploading a key.
|
|
|
|
|
|
|
|
**How to report bug or suggest improvement**
|
|
|
|
### How to report bug or suggest improvement
|
|
|
|
1. [Create](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#create-a-new-issue) issue describing bug, documentation error or suggested improvement.
|
|
|
|
2. In the first line of the issue description, add "@chen.song" to alert project maintainer.
|
|
|
|
|
|
|
|
**Start development**
|
|
|
|
### 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.
|
|
|
|
<br/>**Note:** It is important to copy the repository by forking. You will not be allowed to push changes/branches to the original repository.
|
|
|
|
1. [Fork](https://docs.gitlab.com/ee/gitlab-basics/fork-project.html) repository.
|
|
|
|
2. Add upstream link to be able to update your forked repository.
|
|
|
|
3. Create branch for development. Commit often but meaningfully, e.g. after running unit tests.
|
|
|
|
4. Regularly update your forked repository and pull changes to working branch.
|
|
|
|
2. Clone your forked repository.
|
|
|
|
```
|
|
|
|
git clone <fork_url>
|
|
|
|
```
|
|
|
|
3. Add upstream link to be able to update your forked repository.
|
|
|
|
```
|
|
|
|
git remote add upstream <original_url>
|
|
|
|
```
|
|
|
|
4. Create branch for development. Commit often but meaningfully, e.g. after running unit tests.
|
|
|
|
```
|
|
|
|
git checkout -b <branch_name>
|
|
|
|
```
|
|
|
|
5. Regularly update your forked repository and pull changes to working branch.
|
|
|
|
```
|
|
|
|
|
|
|
|
**How to submit contribution**
|
|
|
|
```
|
|
|
|
|
|
|
|
### How to submit contribution
|
|
|
|
1. 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").
|
|
|
|
<br/>If there is none, please create one (see above "How to report bug or suggest improvement").
|
|
|
|
2. 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.
|
|
|
|
<br/>Use prefix "**WIP:**" in the title to signify this is a work in progress.
|
|
|
|
4. In the issue description, add either "Closes #IssueId" or "Related #IssueId1, #IssueId2" to link related issue.
|
|
|
|
5. The project team will discuss whether the merge request will be included in the official release.
|
|
|
|
6. If the merge request is accepted, please address any question/requests from the project team. |
|
|
\ No newline at end of file |
