We love your input! We want to make contributing to this project as easy and transparent as possible. However we do recommend that you check our pages on how to contribute to our development first.
You can also contribute by:
- Reporting a bug
- Discussing the current state of the code
- Proposing new features
- Telling us what you want us to prioritise - by adding a 👍 to the issue.
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
Once you've finished developing something, Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests - even more so if you follow our development guidelines.
- 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!
- Be part of the exclusive external-contribution-❤️ list.
In short, when you submit code changes, your submissions are understood to be under the same liberal 3-Clause BSD License that covers the project. Feel free to contact the maintainers if that's a concern.
We use GitHub issues to track public bugs.
Report a bug by opening a new issue and use the bug template; it's that easy!
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can (and if relevant).
- Provide screenshots (if relevant).
- 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)
People love thorough bug reports. I'm not even kidding.
By contributing, you agree that your contributions will be licensed under its 3-Clause BSD License.