diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..5e839d04c0 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,26 @@ +# Details about PR + +___Do not mention proprietary info or link to internal work items in this PR.___ + +__Work item:__ _"Internal", or link to GitHub issue (if applicable)._ + +__What were the changes?__ +_One sentence describing the work done._ + +__Why were the changes made?__ +_Explain the motivation behind the work. Provide any publicly-available historical context._ + +__How was the outcome achieved?__ +_Technical details behind the work. Explain any publicly-available hardware peculiarities._ + +__Additional Documentation:__ +_What else should the reviewer know?_ + +## Approval Checklist + +___Do not approve until these items are satisfied.___ + +- [ ] Verify the CHANGELOG has been updated. +- [ ] Verify if the unit test has been added. +- [ ] Verify if the integration test is added. +- [ ] Verify if the documentaiton has been updated.