We love your input! 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
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
Please follow these steps to have your contribution considered by the maintainers:
- Follow our coding standards and style guide
- Write tests for your changes
- Ensure the test suite passes
- Make sure your code lints
- Issue that pull request!
Any contributions you make will be under the license
In short, when you submit code changes, your submissions are understood to be under the same license that covers the project. Feel free to contact the maintainers if that's a concern.
Report bugs using GitHub's Issues
Report a bug by opening a new issue; 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.
- 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)
- 4 spaces for indentation rather than tabs
- More coding style related changes and rules are to come soon. Keep yourself up-to-date!
In short, don't be a jerk. Be respectful and considerate in your interactions.
By contributing, you agree that your contributions will be licensed under its license.