diff options
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..517d318b1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md | |||
@@ -0,0 +1,53 @@ | |||
1 | ## Description | ||
2 | <!-- Please include a summary of the change, with motivation and context --> | ||
3 | |||
4 | ## Related issues | ||
5 | <!--- If suggesting a new feature or change, please discuss it in an issue first --> | ||
6 | <!--- If fixing a bug, there should be an issue describing it with steps to reproduce --> | ||
7 | <!-- start with closing keywords if any apply: https://docs.github.com/en/enterprise/2.16/user/github/managing-your-work-on-github/closing-issues-using-keywords --> | ||
8 | |||
9 | ## Type of change | ||
10 | <!--- Put an `x` in all the boxes that apply: --> | ||
11 | - [ ] ♻️ Refactor discussed in # | ||
12 | - [ ] ✨ Feature as discussed in # | ||
13 | - [ ] 🐛 Bug Fix | ||
14 | - [ ] 👷 Optimization/Maintenance | ||
15 | - [ ] 📝 Documentation Update | ||
16 | - [ ] 🔖 Release | ||
17 | - [ ] 🚩 Other | ||
18 | |||
19 | ## Has this been tested? | ||
20 | <!--- Put an `x` in the box that applies: --> | ||
21 | - [ ] 👍 yes, I added tests to the test suite | ||
22 | - [ ] 👍 yes, light tests as follows are enough | ||
23 | - [ ] 💭 no, because this PR is a draft and still needs work | ||
24 | - [ ] 🙅 no, because they aren't needed | ||
25 | - [ ] 🙋 no, because I need help | ||
26 | |||
27 | <!-- | ||
28 | If you didn't test via unit-testing, you will still be asked to prove your fix is effective, doesn't have side-effects, or that your feature simply works: | ||
29 | |||
30 | Please describe the tests that you ran to verify your changes. | ||
31 | Provide instructions so we can reproduce. | ||
32 | Please also list any relevant details for your test configuration(s): | ||
33 | --> | ||
34 | |||
35 | **Self-test configuration**: | ||
36 | * NodeJS version: <!-- if PR change dependencies --> | ||
37 | * Viewport sizes: <!-- if PR changes UI --> | ||
38 | * Browser name/version: <!-- if PR changes UI --> | ||
39 | |||
40 | ## Screenshots | ||
41 | <!-- delete if not relevant --> | ||
42 | |||
43 | ## Checklist: | ||
44 | <!-- delete unrelevant entries --> | ||
45 | <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
46 | <!--- Put an `x` in all the boxes that apply: --> | ||
47 | - [ ] I have read the [CONTRIBUTING](./.github/CONTRIBUTING.md) documentation. | ||
48 | - [ ] I didn't make the linter cry | ||
49 | - [ ] I have commented my code, particularly in hard-to-understand areas | ||
50 | - [ ] I have made changes to the documentation as needed | ||
51 | - [ ] I have made changes to the OpenAPI spec as needed | ||
52 | - [ ] To the best of my knowledge, my changes introduce no known security vulnerability | ||
53 | - [ ] I have corrected any misspellings in my code/comments | ||