- Identified the issue which this PR solves.
- Read the CONTRIBUTING document.
- Code builds clean without any errors or warnings.
- Added appropriate tests for any new functionality.
- All new and existing tests passed.
- Added comments in the code, where necessary.
- Ran
make checkto catch common errors. Fixed any that came up.
Description: Please include a description of the proposed changes. This should include details if the user experience is impacted.
Which issue(s) this PR fixes: For significant amounts of work, it is best to start an issue first, preferably before the work is started. For large pull requests, be sure to reference the associated GitHub issue(s).
Usage: Fixes #<issue number>, or Fixes (paste link of issue).
Out of Scope: Include any out of scope items here.
Screenshots: If applicable, add some screenshots here.
Describe any introduced user-facing changes: If introducing any user-facing changes, provide a clear description of them.
Describe any introduced API changes: If introducing any API changes, provide a clear description of them.
Additional Info: Any additional information or context.