Please review the releases section of the repository to get the detailed information on changes.
- This project only accepts pull requests related to open issues.
- If suggesting a new feature or change, please discuss it in an issue first.
- If fixing a bug, there should be an issue describing it with steps to reproduce.
- Please link to the issue here: Create Issue
- Why is this change required?
- What problem does it solve?
- Please describe in detail how you tested your changes.
- Include details of your testing environment, and the tests you ran to.
- see how your change affects other areas of the code, etc.
What types of changes does your code introduce? Put an x
in all the boxes that apply:
- Docs change / refactoring / dependency upgrade
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to change)
- Go over all the following points, and put an
x
in all the boxes that apply. - If you're unsure about any of these, don't hesitate to ask. We're here to help!
- My code follows the code style of this project.
- My change requires a change to the documentation.
- I have updated the documentation accordingly.
- I have read the CONTRIBUTING document.
- I have added tests to cover my changes.
- All new and existing tests passed.