Contributing

Introduction

Thank you very much for being here! First of all, I want to let you know that contributions are more than welcome and really appreciated.

In case you want to contribute, even with a small bug fix, you will be featured into the credits list.

Here you can find a list of todo features / updates that are planned and that you can implement to consistently contribute.

To add your contribution, please follow these guidelines:

Fork your own copy of the repository.
Work on your changes / improvements in the forked repo.
Test if your changes / improvements are correctly implemented and all the other features are not compromised. For this latter requirement, please run this script:

./tests/all_tests.sh

and possibly update also the respective files with your news tests, if necessary.

Before submitting the code, reformat it using the .clang-format file. This passage is automatically done if you compile in debug mode.
Optional, but really appreciated: update the documentation (directly while writing the code) and the main README with the new features you added.
Finally, make the pull request. The Doxygen page will be updated automatically.

Once your pull request will be submitted, I will carefully review it and, if it will be considered as an improvement, I will confirm it.

If it is related to a bug, follow this template.

If it is related to a feature request, follow this template.