Continued development on this module is welcome! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
All development will be hosted and maintained in GitHub.
We Use Github Flow
Code Changes Happen Through Pull Requests. Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
In short, when you submit code changes, your submissions are understood to be under the same LGPL v3 that covers the project.
Report bugs using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue.
Bug Reports Should Include:
- A quick summary and/or background
- Steps to reproduce
- Be specific
- Give sample code if you can
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening or any mitigations/resolutions you tried and their effectiveness)
Follow the GNU Coding styles guidelines for c/c++ code.
We recommend using clang-tidy for linting.
By contributing, you agree that your contributions will be licensed under the LGPL v3.