This file contains information and details about contributing to this repository.
You can contribute to this project by
- Submitting issues and/or suggestions
- Testing alpha and prerelease versions
- Looking through the existing issues and contributing to them in your own way
-
Follow the Code of Conduct
-
Submit ALL pull requests through Github
-
Report bugs through Github issues
-
Any contributions made will be under the MIT Software License. By contributing, you agree that your contributions will be made under the MIT License.
-
Write bug reports with detail, background, and sample code
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)
People love thorough bug reports. I'm not even kidding.
Before sending in your pull requests, make sure you followed this list.
- Read the contributing guidelines
- Read the code of conduct
- Ensure changes are consistent with the Code Style