Add some more clarifying information to the contributing file

This commit is contained in:
Alexander Bock
2024-05-27 14:20:00 +02:00
parent 09d4ea6170
commit 099079d77c

View File

@@ -1,4 +1,9 @@
# How to contribute
Contributions to OpenSpace are welcomed and highly encouraged! They can take many forms and all forms of contributions, for example reporting bugs, fixing bugs, creating and sharing new content, writing documentation, and many many other forms. Even creating interesting pictures and videos and sharing them helps.
## :book: Code of Conduct
Please review our [Code of Conduct](../CODE_OF_CONDUCT.md). It is in effect at all times and we expect it to be honored by everyone at all times.
## Code changes
The easiest way to contribute is through a separate fork of the repository and submitting a Pull Request. One of the core developers will review the pull request and integrate it into the `master` branch. Preferably, for each Pull Request, there is an accompanying issue (created by you or not) which the Pull Request addresses. In this case, feel free to use the phrase "(closes #XXX)" in the text of the Pull Request, where `XXX` is the number of the issue that you have solved. The PR should be in its own separate branch following the naming `pr/feature`, where `feature` is a short, descripting name of the additional feature or bug contained in the PR.