diff options
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..9828a36 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +**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, changing a README, or something small like that. --> + +Explain the **details** for making this change. What existing problem does the pull request solve? + +<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. --> + +**Test plan** + +Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. + +<!-- Run some tests to make sure the code doesn't throw any errors, is valid, and works on IE8+. --> +<!-- Also, maake sure that the code formatting is in line with the rest of the project. --> + +**Closing issues** + +Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). |