From 1d4eb34da6085757d1707db0c440c6e245c3e2e3 Mon Sep 17 00:00:00 2001 From: Dmytro Pustovit Date: Tue, 4 May 2021 15:53:12 +0300 Subject: [PATCH] Chore: Update pr template --- .../pull_request_template.md | 47 +++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..62341c3 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,47 @@ +**IMPORTANT: Please do not create a Pull Request without creating an issue first.** + +Please, go through these steps before you submit a PR: +1. Make sure that your PR is not a duplicate. +2. If not, then make sure that: + + a. You have done your changes in a separate branch. Branches MUST have descriptive names that start with either the `fix/` or `feature/` prefixes. Good examples are: `fix/signin-issue` or `feature/issue-templates`. + + b. You have a descriptive commit message with a short title (first line). + + c. You have only one commit (if not, squash them into one commit). + + d. `npm test` doesn't throw any error. If it does, fix them first and amend your commit (`git commit --amend`). + +3. **After** these steps, you're ready to open a pull request. + + a. Give a descriptive title to your PR. + + b. Describe your changes. + + c. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes. + + +*Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.* + + +**IMPORTANT**: Please review the [CONTRIBUTING](../#contribute) section for detailed contributing guidelines. + +**PLEASE REMOVE THIS NOTES BEFORE SUBMITTING** + + + + + +**Fixes** #XX + +Please provide enough information so that others can review your pull request: + + + + +Explain the **details** for making this change. What existing problem does the pull request solve? + + + +A picture tells a thousand words: +