|
|
# Workflow
|
|
|
|
|
|
In order to contribute to mHM, please follow these steps:
|
|
|
|
|
|
1. Fork the ``mHM`` repository:
|
|
|
|
|
|
![01_fork](uploads/f30b81f4edeee34c68c32c2da32379c7/01_fork.png)
|
|
|
|
|
|
Under ``Settings -> General -> Visibility, project features, permissions`` you can set the ``Project visibility `` to ``internal`` to prevent access to your development from outside the UFZ.
|
|
|
|
|
|
2. Clone your fork **as described below**:
|
|
|
|
|
|
![02_clone](uploads/dbc10b0e5be4871803d57c660bb1f1d4/02_clone.png)
|
|
|
|
|
|
3. Create your neat mindblowing feature **as described below**.
|
|
|
|
|
|
4. Merge request:
|
|
|
|
|
|
- create a merge request:
|
|
|
|
|
|
![03_merge_request](uploads/5e06b8e06a9e783a95aeffd8fafbb203/03_merge_request.png)
|
|
|
|
|
|
- select a new merge request:
|
|
|
|
|
|
![04_new_merge](uploads/593a5d2ca1327da0447808369ac32a4d/04_new_merge.png)
|
|
|
|
|
|
- select your feature branch as source
|
|
|
|
|
|
![05_select_branches](uploads/bc0a2b9ad5aa8b887cef7558ce6db65e/05_select_branches.png)
|
|
|
|
|
|
- describe your merge request
|
|
|
|
|
|
![06_create_merge](uploads/13f7bc10bf6e8bfe203046456ce5ad0f/06_create_merge.png)
|
|
|
|
|
|
5. SUBMIT! Hurray.
|
|
|
|
|
|
# Working in your Fork
|
|
|
|
|
|
After creating the fork, you clone it to your local machine to work on it:
|
|
|
|
|
|
git clone git@git.ufz.de:<you>/mhm.git
|
|
|
|
|
|
Now create a feature branch and check it out (there your work is done!):
|
|
|
|
|
|
git checkout -b your_feature_branch
|
|
|
|
|
|
To stay up to date with the original ``develop`` branch, we add the mHM repository as an upstream branch:
|
|
|
|
|
|
git remote add upstream git@git.ufz.de:mhm/mhm.git
|
|
|
|
|
|
If there was a new commit to the ``develop`` branch of mHM, you can fetch it:
|
|
|
|
|
|
git fetch upstream
|
|
|
|
|
|
And then you can merge it into your feature branch (this can be tricky if things overlap...good luck!):
|
|
|
|
|
|
git merge upstream/develop
|
|
|
|
|
|
After working with `git add ...` and `git commit ...` as always, you have to push your changes to your repository on git.ufz.de:
|
|
|
|
|
|
git push origin your_feature_branch
|
|
|
|
|
|
Then you can continue with the merge request as described in 4. |
|
|
\ No newline at end of file |