We welcome any contribution, whether it is about:
We want to make contributing to this project as easy and transparent as possible.
We use github to host code, to track issues and feature requests, as well as accept 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
master
. - If you've added code that should be tested, add tests.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce: be specific and 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 stuff you tried that didn't work)
When you submit code changes, your submissions are understood to be under the same AGPL-3.0 License that covers the project. Feel free to contact the maintainers if that's a concern. By contributing, you agree that your contributions will be licensed under its AGPL-3.0 License.
This document was adapted from briandk's template for contributing guidelines