Provide a general summary of your changes in the title above. You should
remove this overview, any sections and any section descriptions you
don't need below before submitting. There isn't a strict requirement to
use this template if you can structure your description and still cover
these points.
Description
Describe your changes in detail through motivation and context. Why is
this change required? What problem does it solve? If it fixes an open
issue, link to the issue using GitHub's closing issues keywords1.
Has your change been tested?
Explain how the change has been tested and what you ran to confirm your
change affects other parts of the code. Automated tests are generally
expected and changes without tests should explain why they aren't
required.
Screenshots (if appropriate):
Types of changes
What sort of change does your code introduce/modify?
[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
[x] My code follows the code style of this project.
[x] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[x] I have added tests to cover my changes.
[x] All new and existing tests passed.
[x] This change is using publicly documented and stable APIs.
Provide a general summary of your changes in the title above. You should remove this overview, any sections and any section descriptions you don't need below before submitting. There isn't a strict requirement to use this template if you can structure your description and still cover these points.
Description
Describe your changes in detail through motivation and context. Why is this change required? What problem does it solve? If it fixes an open issue, link to the issue using GitHub's closing issues keywords1.
Has your change been tested?
Explain how the change has been tested and what you ran to confirm your change affects other parts of the code. Automated tests are generally expected and changes without tests should explain why they aren't required.
Screenshots (if appropriate):
Types of changes
What sort of change does your code introduce/modify?
Checklist: