Include a short description of the proposed changes to the project, as well as the reasoning and motivation behind them.
If applicable, identify (can be a bulleted list) and link to each proposed feature request which this PR fulfills. If the PR adds additional features for which no feature requests exists, feel free to create a new set of feature requests so that they can be tracked seperately.
Identify and link to each proposed Issue which this PR resolves. If the issue is only partially resolved by the PR, you can still list it, but please be sure to note exactly which part of the issue the PR solves.
If applicable, identify all project features or use cases which the changes break. Please offer some exaplaination as to why these breaking changes are necessary.
If applicable, please note here that the changes are going to require an update of the project documentaton, and if so, please identify specific sections which should be updated.
Please outline the steps that have been taken to test the functionality of the new changes and the functionality of the portions of the project affected by the changes. Please also provide data and observations from the test results, as well as details about any unique testing situations.
- My code follows the style guidelines of this project (it passes
npm run lint
) - I have performed a self-review of my own code
- I have commented my code, particularly in hard-to-understand areas
- I have made/proposed corresponding changes to the documentation
- My changes generate no new warnings (It passes
npm run build
) - I have added tests that prove my fix is effective or that my feature works
- New and existing unit tests pass locally with my changes (It passes
npm test
) - Any dependent changes have been merged and published in downstream modules