From 6cbe32d8cd7b4c949114d16451a023c243b3bba4 Mon Sep 17 00:00:00 2001
From: Iain Sproat <68657+iainsproat@users.noreply.github.com>
Date: Mon, 15 Aug 2022 10:33:27 +0100
Subject: [PATCH] GitHub template update (#921)

* fix(pull request template): pR template should be the default and not an option
  - PR template was in a directory which allows selection using queries.  The PR template should be
provided by default so should be renamed and placed in the .github directory.
  - Remove obsolete template
---
 ...R_TEMPLATE.md => pull_request_template.md} | 22 ++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)
 rename .github/{PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md => pull_request_template.md} (74%)

diff --git a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md b/.github/pull_request_template.md
similarity index 74%
rename from .github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md
rename to .github/pull_request_template.md
index 637e5f616..1efeba6a8 100644
--- a/.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md
+++ b/.github/pull_request_template.md
@@ -34,7 +34,7 @@ Connects #123
 
 -->
 
-## To-do before merge
+## To-do before merge:
 
 <!---
 
@@ -72,9 +72,9 @@ This checklist is mostly useful as a reminder of small things that can easily be
 
 forgotten – it is meant as a helpful tool rather than hoops to jump through.
 
-Put an `x` in all the items that apply, make notes next to any that haven't been
+Put an `x` between the square brackets, e.g. [x], for all the items that apply,
 
-addressed, and remove any items that are not relevant to this PR.
+make notes next to any that haven't been addressed, and remove any items that are not relevant to this PR.
 
 -->
 
@@ -84,3 +84,19 @@ addressed, and remove any items that are not relevant to this PR.
 - [ ] My code follows a similar style to existing code.
 - [ ] I have added appropriate tests.
 - [ ] I have updated or added relevant documentation.
+
+## References
+
+<!---
+
+(Optional -- remove this section if not needed )
+
+Include **important** links regarding the implementation of this PR.
+
+This usually includes a RFC or an aggregation of issues and/or individual conversations
+
+that helped put this solution together. This helps ensure we retain and share knowledge
+
+regarding the implementation, and may help others understand motivation and design decisions etc..
+
+-->