docs: revise PR template following Eng Forum (#472)

* docs: revise PR template following Eng Forum * docs: add more details. * add comment/description to follow Github terminology * fix typos * fix: adjust font sizing * fix: remove unneeded instructions around commit message structure * feat: add checkboxes * adjust spacing * fix: use native GH markdown syntax * remove full-stops from examples Co-authored-by: Krupa Pammi <[email protected]>
comicrelief · Aug 15, 2022 · d25fbdd · d25fbdd
1 parent dc6b872
commit d25fbdd
Showing 1 changed file with 27 additions and 5 deletions.
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -1,8 +1,30 @@
-Type: patch
+### PR Titles
+#### To pass testing pipeline, these need to follow Conventional Commits spec:
+https://www.conventionalcommits.org/en/v1.0.0/
+e.g.
+`feat: create NewForm component`
+or
+`fix: update broken link in NewForm component`
 
-Fixes #
 
-## Changes proposed in this PR
+### PR description
+#### What is it doing?
+Tell us what it is doing from a technical perspective.
 
-- Briefly describe the changes in this PR
-- Do you have some test asserting this behavior?
+#### Why is this required?
+Tell us why this is required from a business/product perspective.
+
+#### link to Jira ticket:
+Add a link to the Jira ticket.
+
+
+### Quick Checklist:
+- [ ] My PR title follows the Conventional Commit spec.
+
+- [ ] I have filled out the PR description as per the template above.
+
+- [ ] I have added tests to cover new or changed behaviour.
+
+- [ ] I have updated any relevant documentation.
+
+### Important! - lastly, make sure to squash merge...