-
Soeren Peters authoredAdds authors and contributing file. Clean up the readme file. Set the minimum cmake version to 3.13 according to the readme entry. Set the options BUILD_VF_CPU, BUILD_VF_GPU and BUILD_VF_UNIT_TEST to OFF by default.
Soeren Peters authoredAdds authors and contributing file. Clean up the readme file. Set the minimum cmake version to 3.13 according to the readme entry. Set the options BUILD_VF_CPU, BUILD_VF_GPU and BUILD_VF_UNIT_TEST to OFF by default.
After you've reviewed these contribution guidelines, you'll be all set to
contribute to this project.
CONTRIBUTING.md 1.35 KiB
Contributing
If you want to contribute to VirtualFluids, your help is very welcome. To contribute use a pull request as follows:
How to make a clean pull request
- Create a personal fork of VirtualFluids.
- Clone the fork on your local machine. Your remote repo on gitea 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
developoropen_source. - Implement/fix your feature, comment your code.
- Follow the code style of the project, including indentation.
- Run the tests.
- 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
developoropen_sourcebranch - …
- 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
upstreamto 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.