|
| 1 | +### :scroll: Description |
| 2 | + |
| 3 | +- Describe the general shape of this PR (new feature? refactor? bug fix? one-line change?) |
| 4 | +<!--- Add your answer here --> |
| 5 | + |
| 6 | +- Describe what changes are being made |
| 7 | +<!--- Add your answer here --> |
| 8 | + |
| 9 | +- Describe why these changes are being made |
| 10 | +<!--- Add your answer here --> |
| 11 | + |
| 12 | +- List the use cases and edge cases relevant to this PR |
| 13 | +<!--- Add your answer here --> |
| 14 | + |
| 15 | +- Describe how errors will be handled. How will we know if this code breaks in production |
| 16 | +<!--- Add your answer here --> |
| 17 | + |
| 18 | +- Describe any external libraries/dependencies added or removed in this PR |
| 19 | +<!--- Add your answer here --> |
| 20 | + |
| 21 | +- Describe any security risks are there regarding this change |
| 22 | +<!--- Add your answer here --> |
| 23 | + |
| 24 | +- Describe how you tested these changes |
| 25 | +<!--- Add your answer here --> |
| 26 | + |
| 27 | +- Link to relevant external documentation |
| 28 | +<!--- Add your answer here --> |
| 29 | +<!--- Example: API docs, architecture diagrams, MDN docs --> |
| 30 | + |
| 31 | + |
| 32 | +-------------------------- |
| 33 | +### :clipboard: Mandatory Checklist |
| 34 | + |
| 35 | +- [x] Example of a checked item (please remove when creating your Pull Request) |
| 36 | + |
| 37 | +- [ ] Linked to the Github Issues being addressed using the right sidebar :arrow_right: |
| 38 | +- [ ] Have you discussed these changes with the project leader(s)? |
| 39 | +- [ ] Do all variable and function names communicate what they do? |
| 40 | +- [ ] Were all the changes commented and / or documented? |
| 41 | +- [ ] Is the PR the right size? (If the PR is too large to review, it might be good to break it up into multiple PRs.) |
| 42 | +- [ ] Does all work in progress, temporary, or debugger code have a TODO comment with links to Github issues? |
| 43 | +- [ ] *If you changed the user interface, did you add before and after screenshots to below?* |
| 44 | + |
| 45 | +-------------------------- |
| 46 | +### :framed_picture: Screenshots and Screen Recordings |
| 47 | + |
| 48 | +#### Before |
| 49 | +<!--- Add before screenshots here --> |
| 50 | + |
| 51 | + |
| 52 | +#### After |
| 53 | +<!--- Add after screenshots here --> |
| 54 | + |
| 55 | + |
| 56 | +-------------------------- |
| 57 | +### :blue_book: Glossary |
| 58 | +- PR = Pull Request |
0 commit comments