Add a CONTRIBUTING.md file #46
Description
To handle especially external contributions, but also for students in our group a CONTRIBUTING.md file would be beneficial.
Ideas which info this file could contain*:
- consistency in code
- formatting the code (after tackling issue Add formatter script to sampler codebase #30)
- coding rules/style?
- testing?
- info about proper commit messages
- how to open a descriptive/meaningful PR
- feature branches might be rebased
*Not exclusively, I might have forgotten something. Please expand the list if needed.
The SMASH CONTRIBUTING.md might be a good inspiration.
Note
I assign this issue to myself just that it's not unassigned, but I might take a while to tackle it due to other obligations. If someone wants to take over, go for it!