IMPORTANT: Please do not create a Pull Request without creating an issue first.
Any change needs to be discussed before proceeding. Failure to do so may result
in the rejection of the pull request.
Please provide enough information so that others can review your pull request. You
can skip this if you're fixing a typo or adding an app to the Showcase.
Explain the details for making this change. What existing problem does the pull
request solve?
Ex:
If you "Added a/changed the function to do X", explain why:
it is necessary to have a way to do X.
if there already exists a way, why is your implementation better
If you "Fixed bug/error in X", explain:
what was the bug/error (if you already made an issue, please link to it here)
IMPORTANT: Please do not create a Pull Request without creating an issue first.
Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.
Please provide enough information so that others can review your pull request. You can skip this if you're fixing a typo or adding an app to the Showcase.
Explain the details for making this change. What existing problem does the pull request solve?
Ex:
If you "Added a/changed the function to do X", explain why:
If you "Fixed bug/error in X", explain:
Code style and formatting
Check the Contributors Style Guidelines section for how to write your code and the Contributors Code Formatting section for how to format your code.
Closing Issues
Put
closes #XXXXin your comment to auto-close the issue that your PR fixes (if such).Fixes #XXXX
Proposed changes
*
Motivation behind changes
Test plan
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
Make sure tests pass on all of the relevant CI workflows.
Pull Request Readiness Checklist
See details at CONTRIBUTING.md.
[ ] I agree to contribute to the project under [INSERT PROJECT NAME] (Unlicense) License.
[ ] To the best of my knowledge, the proposed patch is not based on a code under GPL or other license that is incompatible with [INSERT PROJECT NAME]
[ ] The PR is proposed to proper branch
[ ] There is reference to original bug report and related work
[ ] There is accuracy test, performance test and test data in the repository, if applicable
[ ] The feature is well documented and sample code can be built with the project CMake