Contributing to this project should be 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
Github is used 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.
- Fork the repo and create your branch from
master. - If you've changed something, update the documentation.
- Issue a pull request
By contributing, you agree that your contributions will be licensed under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
This project uses black to ensure the code follows a consistent style.
GitHub issues are used to track public bugs. Report a bug by opening a new issue
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- 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)