If you want to contribute to VirtualFluids, your help is very welcome.
To contribute use a pull request as follows:
To contribute use a merge request as follows:
### How to make a clean pull request
### How to make a clean merge request
- Create a personal fork of VirtualFluids.
- Clone the fork on your local machine. Your remote repo on gitea is called `origin`.
- Clone the fork on your local machine. Your remote repo on gitlab is called `origin`.
- Add the original repository as a remote called `upstream`.
- If you created your fork a while ago be sure to pull upstream changes into your local repository.
- Create a new branch to work on! Branch from `develop` or `open_source`.
...
...
@@ -16,10 +16,10 @@ To contribute use a pull request as follows:
- Write or adapt tests as needed.
- Add or change the documentation as needed.
- Push your branch to your fork on gitea, the remote `origin`.
- From your fork open a pull request in the correct branch. Target the project's `develop` or `open_source` branch
- From your fork open a merge request in the correct branch. Target the project's `develop` or `open_source` branch
- …
- If we requests further changes just push them to your branch. The PR will be updated automatically.
- Once the pull request is approved and merged you can pull the changes from `upstream` to your local repo and delete
- If we requests further changes just push them to your branch. The MR will be updated automatically.
- Once the merge request is approved and merged you can pull the changes from `upstream` to your local repo and delete
your extra branch(es).
And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code.
