Thank you for considering contributing to nekRS! Here are a few important things you should know about contributing:
-
Please create a pull request (PR) on GitHub merging into the latest next branch.
-
We prefer a PR for one thing at a time. If you have many contributions, please split them in different PRs.
-
If you are planning a large contribution, we encourage you to interact with us early on (via GitHub or email) to ensure that your effort is well-directed.
-
Mimic our coding style/conventions and respect our design. Your contribution should fit well in the existing source code.
-
Update the surrounding e.g. examples, documentation (whatever is affected by your contribution).
-
Do not break the code. Any significant changes should be accompanied by tests. The project already has good test coverage, so look at some existing tests if you're unsure how to go about it.
-
Provide evidence of correctness and performance.
-
Comment on limitations and known issues.
-
Your PR will be reviewed by subject matter experts and finally by the maintainer. We will either merge it, request changes to it, or close it with an explanation.
-
Be prepared to accept constructive criticism on your code and to work on improving it before it's merged.
-
The act of submitting a PR (with or without an explicit Signed-off-by tag) will be understood as an affirmation of the developer certificate of origin (DCO), which you can find at http://developercertificate.org/.
-
In some cases (e.g. squashed commits) we won't preserve the original commit author information. However all contributors are acknowledged in the notes of each release.