Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.
If it fixes a bug be sure to link to that issue. If it resolves a feature request, be sure to link to that discussion.
What types of changes does your code introduce to this repository?
Put an x
in the boxes that apply
- Bugfix (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 not work as expected)
- Documentation Update
Put an x
in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.
- Lint and unit tests pass locally with my changes (if applicable)
- I have run pre-commit (
pre-commit
in the repo) - I have added tests that prove my fix is effective or that my feature works
- I have added necessary documentation (if appropriate)
- Linked to the relevant github issue or github discussion
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...