Describe the big picture of your changes here to make it clear what your pull request will change. Make sure to explain the what e.g. the functionality it changes not the how e.g. what code you have written. If it fixes a bug or resolves a feature request, be sure to link to that issue.
Types of changes
What types of changes does your code introduce?
Put an x in the boxes that apply
[ ] Bugfix (change which fixes an issue)
[ ] New feature (change which adds functionality)
[ ] Documentation Update (change to naming or other documentation)
Checklist
Put an x in the boxes that apply. You can also fill these out after creating the PR.
[ ] I have added unit tests that prove my fix is effective or that my feature works
[ ] I have added necessary documentation (if appropriate)
[ ] I have checked that my changes have not broken any other functionality
[ ] I have linked to any issues this PR fixes
Points for review
Add checkboxes here for any specific aspects of your PR you would like to be checked in peer review. If you don't specify anything here, the reviewer will check:
[ ] All of your unit tests pass
[ ] Your code is clear and easy to understand
[ ] You have documented any new features
[ ] They can run the code you have written
[ ] Your changes do not break any other functionality
Who is reviewing this PR?
Tag your reviewer here to ensure they get a notification!
Proposed changes
Describe the big picture of your changes here to make it clear what your pull request will change. Make sure to explain the what e.g. the functionality it changes not the how e.g. what code you have written. If it fixes a bug or resolves a feature request, be sure to link to that issue.
Types of changes
What types of changes does your code introduce? Put an
xin the boxes that applyChecklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR.Points for review
Add checkboxes here for any specific aspects of your PR you would like to be checked in peer review. If you don't specify anything here, the reviewer will check:
Who is reviewing this PR?
Tag your reviewer here to ensure they get a notification!