Describe your changes in detail.
Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here (if you write fixes #num
or closes #num
, the issue will be automatically closed when the pull is accepted.)
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:
- 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.
- I have read the CONTRIBUTING document.
- My pull request addresses exactly one patch/feature.
- I have created a branch for this patch/feature.
- Each individual commit in the pull request is meaningful.
- I have added tests to cover my changes.
- If my change requires a change to the documentation, I have updated it accordingly.
If you're unsure about any of these, don't hesitate to ask. We're here to help!