🐛 If you've spotted a bug or want to request a feature please send an issue through github. Please choose the "bug" or "feature" template (as appropriate) and fill it out with much information as you can. We really appreciate bug reports and feature requests. Thanks!
🚀 If you want to contribute code, or you have reported a bug and think you have a fix, then please:
- fork this repository,
- make your changes and check they compile,
- commit and push the changes to your fork
- (optional but appreciated) setup and run pre-commit which automates our code tidyup,
- and submit a pull request (PR) against the
mainbranch.
When you're submitting a PR please give as much context as possible and link to any issues of relevance. You can use our PR template as a starting point, but here are some guidelines we try to follow:
- Focus on a single feature or bug fix. One set of logically consistent changes per PR.
- Ideally a PR should touch 100s, not 1000s, of lines.
- Add test(s) to ensure the correct functionality or which reproduce the bug and demonstrate the fix.
- Document your code changes, we use doxygen for C++.
You can find more information in our developer and API documentation.