ContributingΒΆ

We are very happy if you want to share your contributions to DynaPlex with the rest of the community.

All contributions are submitted through GitHub Pull Requests.

Before we can accept a pull request and merge your changes into the master branch, you must meet the following requirements:

  • Commit messages are clear and short

  • Your branch passes the 2 unit test, see the ExecuteTests() function in the src/tests folder

  • Your code is well tested and bugfree, please include the test files such that we can test ourselves too

  • Please only submit a single new feature in a branch, do not submit a large heap of changes in your branch

  • Please document your code well using comments, follow the same commenting standard used in the rest of the code

  • If applicable, you also need to update the documentation in the /docs folder