| ... | ... | @@ -6,7 +6,7 @@ You need a Gitlab account on our server to contribute. |
|
|
|
|
|
|
|
### 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.
|
|
|
|
2. In the first line of the issue description, add "**@chen.song**" to alert project maintainer.
|
|
|
|
|
|
|
|
### Start development
|
|
|
|
If you want to do your own development on the project, follow the instructions below.
|
| ... | ... | @@ -23,17 +23,29 @@ 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>
|
|
|
|
...
|
|
|
|
git status
|
|
|
|
git add/rm ...
|
|
|
|
git commit ...
|
|
|
|
...
|
|
|
|
git push origin <branch_name>
|
|
|
|
```
|
|
|
|
5. 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
|
|
|
|
1. Make sure an issue exists that directly corresponds to the bugfix/feature you would like to contribute.
|
|
|
|
<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.
|
|
|
|
1. Make sure an [issue](https://emcl-gitlab.iwr.uni-heidelberg.de/hiflow3.org/hiflow3/issues) exists that directly corresponds to the bugfix/feature you would like to contribute.
|
|
|
|
<br/>If there is none, please create one (see above "*How to report bug or suggest improvement*").
|
|
|
|
2. [Create](https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html) merge request. Select your working branch as source and the original repository's master as target.
|
|
|
|
<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.
|
|
|
|
4. In the issue description, add either "**Closes #IssueId**" and/or "**Related #IssueId1, #IssueId2**" to link related issues to your merge request.
|
|
|
|
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 |
