From 3f2fd47a0635f401a4d175af5ff44712cb628713 Mon Sep 17 00:00:00 2001
From: adbridge <anna.bridge@arm.com>
Date: Thu, 21 Nov 2019 16:18:19 +0000
Subject: [PATCH 1/3] Simplify headers and instructions

There is confusion with having sub headings below Description.
This commit removes teh Description header completely and promotes
sub headings to full headings.

Some of the notes under each heading have also been updated to
provide better clarity.
---
 .github/pull_request_template.md | 36 ++++++++++++++++++++------------
 1 file changed, 23 insertions(+), 13 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 3084df799c..e0f8b7056b 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,25 +1,38 @@
 <!--
 For more information on the requirements for pull requests, please see [the contributing guidelines](https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html).
+
+NOTE: Do not remove any of the template headings (even for optional sections) as this
+template is automatically parsed. 
 -->
 
-### Description 
-#### Summary of change <!-- Required -->
+### Summary of changes <!-- Required -->
 
-<!-- Basic information about the change: what the change is for, why do we need it any implications -->
+<!-- 
+    Please provide the following information: 
 
-#### Documentation <!-- Optional, but most likely you need it -->
+    Description of the the change (what is this fixing / adding / removing?).
 
-<!-- Details of any document updates required, including links to PR against the docs repository -->
+    Why the change is needed (if this is fixing a reported issue please summarize what
+    the issue is and add the reference. E.g. Fixes #17119).
+
+    Any implications for users taking this change.
+ -->
+
+### Documentation <!-- Required -->
+
+<!-- 
+    Please provide details of any document updates required, including links to any
+    related PRs against the docs repository.
+    If no document updates are required please specify 'None', this at least tells us
+    that this has been considered.
+-->
 
 ----------------------------------------------------------------------------------------------------------------
 ### Pull request type <!-- Required -->
 
 <!--
-    Required
     Please add only one X to one of the following types. Do not fill multiple types (split the pull request otherwise).
-    Please note this is not a GitHub task list, indenting the boxes or changing the format to add a '.' or '*' in front
-    of them would change the meaning incorrectly. The only changes to be made are to add a description text under the
-    description heading and to add a 'x' to the correct box.
+    Please note this is not a GitHub task list, indenting the boxes or changing the format to add a '.' or '*' in front of them would change the meaning incorrectly. 
 -->
     [] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
     [] Feature update (New feature / Functionality change / New API)
@@ -29,9 +42,7 @@ For more information on the requirements for pull requests, please see [the cont
 ### Test results <!-- Required -->
 
 <!--
-    Required
-    Provide all the information required, listing all the testing performed. For new targets please attach full test results
-    for all supported compilers.
+    Provide all the information required, listing all the testing performed. For new targets please attach full test results for all supported compilers.
 -->
     [] No Tests required for this change (E.g docs only update)
     [] Covered by existing mbed-os tests (Greentea or Unittest)
@@ -42,7 +53,6 @@ For more information on the requirements for pull requests, please see [the cont
 ### Reviewers <!-- Optional -->
 
 <!--
-    Optional
     Request additional reviewers with @username or @team
 -->
 

From ba0bca946265b6c62f7f00d8906a216640ed6982 Mon Sep 17 00:00:00 2001
From: adbridge <anna.bridge@arm.com>
Date: Fri, 22 Nov 2019 11:29:09 +0000
Subject: [PATCH 2/3] Remove release notes section

Feedback has shown that having similar fields in the release notes
section to the main headings is confusing. This PR simplifies the
sections and removes the release notes section completely.

Changes will be required to the release scripts and the docs to
reflect these changes.
---
 .github/pull_request_template.md | 36 +++++++++++++++++++-------------
 1 file changed, 22 insertions(+), 14 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index e0f8b7056b..f93105abf7 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -16,7 +16,28 @@ template is automatically parsed.
     the issue is and add the reference. E.g. Fixes #17119).
 
     Any implications for users taking this change.
- -->
+    
+    NOTE: This section is automatically written to release notes for Feature and 
+    Major releases and should contain enough details for a user.
+    
+-->
+
+### Impact of changes <!-- Optional -->
+<!-- 
+    If there are any implications for users taking this change then they must be 
+    provided here. For Major PR types this field is MANDATORY.
+
+    NOTE: This section is automatically written to release notes for Feature and 
+    Major releases and should contain enough details for a user.
+-->
+
+### Migration actions required <!-- Optional -->
+<!-- 
+    This should only be applicable in Major PR types for which this field is MANDATORY.
+
+    NOTE: This section is automatically written to release notes for Feature and 
+    Major releases and should contain enough details for a user.
+-->
 
 ### Documentation <!-- Required -->
 
@@ -57,16 +78,3 @@ template is automatically parsed.
 -->
 
 ----------------------------------------------------------------------------------------------------------------
-### Release Notes <!-- Required for features, deprecations, breaking changes and other major PRs -->
-
-<!--
-    All 3 sections are compulsory for Major PR types. For Feature PRs only the summary section is required.
-    This section is automatically added to release notes. Please fill in each sub-section with sufficient detail for a user.
-    For more information, please see [the contributing guidelines](https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html#pull-request-types). 
--->
-
-#### Summary of changes
-
-#### Impact of changes
-
-#### Migration actions required

From fa02380b225e8e2bd9622f8b3d1a0604873984ad Mon Sep 17 00:00:00 2001
From: adbridge <anna.bridge@arm.com>
Date: Fri, 22 Nov 2019 12:10:21 +0000
Subject: [PATCH 3/3] Remove unecessary text and reinstate sub headings

---
 .github/pull_request_template.md | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index f93105abf7..9a6aba3ae8 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -15,14 +15,12 @@ template is automatically parsed.
     Why the change is needed (if this is fixing a reported issue please summarize what
     the issue is and add the reference. E.g. Fixes #17119).
 
-    Any implications for users taking this change.
-    
     NOTE: This section is automatically written to release notes for Feature and 
     Major releases and should contain enough details for a user.
     
 -->
 
-### Impact of changes <!-- Optional -->
+#### Impact of changes <!-- Optional -->
 <!-- 
     If there are any implications for users taking this change then they must be 
     provided here. For Major PR types this field is MANDATORY.
@@ -31,7 +29,7 @@ template is automatically parsed.
     Major releases and should contain enough details for a user.
 -->
 
-### Migration actions required <!-- Optional -->
+#### Migration actions required <!-- Optional -->
 <!-- 
     This should only be applicable in Major PR types for which this field is MANDATORY.