Include a summary of the change and which issue it addresses in the title of the PR.
Include relevant motivation, context, brief description and impact of the change(s). List follow-up tasks here.
How Has This Been Tested?
Describe the tests that you ran to verify your changes. Provide instructions for reproduction.
[ ] Test A (e.g. Test A - New test that ... ran in local, docker, and dev unstable.)
[ ] Test B
Definition of Done
Before submitting this PR, please make sure:
[ ] The work addresses the description and outcomes in the issue
[ ] I have added relevant tests for new or updated functionality
[ ] My code follows conventions, is well commented, and easy to understand
[ ] My code builds and tests pass without any errors or warnings
[ ] I have tagged the relevant reviewers
[ ] I have updated the READMEs of affected packages
[ ] I have made corresponding changes to the documentation
[ ] The changes have been communicated to interested parties
References:
Please list relevant documentation (e.g. tech specs, articles, related work etc.) relevant to this change, and note if the documentation has been updated.
[Replace Me With Meaningful Name] - #[Issue]
Description
Include a summary of the change and which issue it addresses in the title of the PR.
Include relevant motivation, context, brief description and impact of the change(s). List follow-up tasks here.
How Has This Been Tested?
Describe the tests that you ran to verify your changes. Provide instructions for reproduction.
Definition of Done
Before submitting this PR, please make sure:
References:
Please list relevant documentation (e.g. tech specs, articles, related work etc.) relevant to this change, and note if the documentation has been updated.