Chore: adds 'typo' PR template

pustovitDmytro · Jul 12, 2021 · e20404d · e20404d
1 parent a969a8d
commit e20404d
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 5 deletions.
diff --git a/...REQUEST_TEMPLATE/pull_request_template.md → .github/PULL_REQUEST_TEMPLATE.md b/...REQUEST_TEMPLATE/pull_request_template.md → .github/PULL_REQUEST_TEMPLATE.md
@@ -10,7 +10,9 @@ Please, go through these steps before you submit a PR:
 
     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`).
+    d. Commit message follows [convention](../CONTRIBUTING.md#commit-message). Good example is: `Docs: fixes typo in 'rejection' word`.
+
+    e. `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.
 
@@ -26,10 +28,7 @@ Please, go through these steps before you submit a PR:
 
 **IMPORTANT**: Please review the [CONTRIBUTING](../#contribute) section for detailed contributing guidelines.
 
-**PLEASE REMOVE THIS NOTES BEFORE SUBMITTING**
-
-
-
+**PLEASE REMOVE THESE NOTES BEFORE SUBMITTING**
 
 
 **Fixes** #XX

diff --git a/.github/PULL_REQUEST_TEMPLATE/typo.md b/.github/PULL_REQUEST_TEMPLATE/typo.md
@@ -0,0 +1,26 @@
+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 `docs/` prefix. Good examples are: `docs/readme-typo` or `docs/typo-guideline`.
+    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. Commit message follows [convention](../CONTRIBUTING.md#commit-message). Good example is: `Docs: fixes typo in 'rejection' word`.
+    e. The changes relate to the documentation only (README.md .github/* docs/*). **Use another pr template otherwise**.
+
+3. **After** these steps, you're ready to open a pull request.
+    a. Give a descriptive title to your PR.
+    b. Describe your changes. Add link to the generally accepted dictionary with correct usage.
+    c. In case there is an opened issue, put `closes #XXXX` in your comment to auto-close the issue that your PR fixes.
+
+
+**PLEASE REMOVE THESE NOTES BEFORE SUBMITTING**
+
+
+**Fixes typo** [ word / sentence / filename ]
+
+Describe your changes:
+
+<!-- Example: This PR fixes typo in 'rejection' word. -->
+
+Add link to the generally accepted dictionary with correct usage:
+<!-- Example: https://www.lexico.com/definition/rejection-->