As an open-source, community driven project, we want to make contributing as easy and transparent as possible. This could include:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
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
develop. - If you've added code that should be tested, add tests.
- If you've changed APIs or environment variables, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Submit that pull request!
Report bugs using Github's Issues
We use GitHub issues 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)