Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.
If this relates to a card, please include a link to the card here. Additionally, please terminate the PR title with # and the card number, such as Fix doomsday bug #1234
What types of changes does your code introduce?
Put an x in the boxes that apply
- feat: non-breaking change which adds new functionality
- fix: non-breaking change which fixes a bug or an issue
- chore(deps): changes to dependencies
- test: adds or modifies a test
- docs: creates or updates documentation
- style: changes that do not affect the meaning or function of code (e.g. formatting, whitespace, missing semi-colons etc.)
- perf: code change that improves performance
- revert: reverts a commit
- refactor: code change that neither fix a bug nor add a new feature
- ci: changes to continuous integration or continuous delivery scripts or configuration files
- chore: general tasks or anything that doesn't fit the other commit types
Please indicate if your PR introduces a breaking change
- Breaking change: fix or feature that would cause existing functionality to not work as expected
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.
- I have read the Contributing doc
- I have read the Creating and reviewing pull requests at LinkORB guide doc
- Lint and unit tests pass locally with my changes
- I have added/updated necessary documentation in the README.md or doc/ directories (if appropriate)
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...