From 2127b45953ed5baabcae3914d40c28951b26c191 Mon Sep 17 00:00:00 2001
From: adbridge <anna.bridge@arm.com>
Date: Wed, 25 Sep 2019 11:55:00 +0100
Subject: [PATCH 1/6] Simplify pull request template

Condense multiple options into the main three and summarise what
can go into those 3 types.

Add a test results section.

Add compulsory sections to Release Notes.
---
 .github/pull_request_template.md | 31 +++++++++++++++++++++----------
 1 file changed, 21 insertions(+), 10 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index e67f72f0377..6ee650acb08 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -16,13 +16,16 @@
     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.
 -->
-    [ ] Fix
-    [ ] Refactor
-    [ ] Target update
-    [ ] Functionality change
-    [ ] Docs update
-    [ ] Test update
-    [ ] Breaking change
+    [ ] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
+    [ ] Feature update (New feature / Functionality change / New API)
+    [ ] Major update (Breaking change E.g. Return code change / API behaviour change)
+
+### Test results 
+
+<!--
+    Optional
+    For example, add test results for new target
+-->
 
 ### Reviewers
 
@@ -34,7 +37,15 @@
 ### Release Notes
 
 <!--
-    Optional
-    In case of breaking changes, functionality changes or refactors, please add release notes here. 
-    For more information, please see [the contributing guidelines](https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html#pull-request-types).
+    This section is compulsory for all Feature and Major PR types.
+    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 4e505f6b528689e855f55b8acdf04f1133c45da1 Mon Sep 17 00:00:00 2001
From: Anna Bridge <Anna.Bridge@arm.com>
Date: Wed, 25 Sep 2019 15:38:53 +0100
Subject: [PATCH 2/6] Add test results section

Also add section separators
---
 .github/pull_request_template.md | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 6ee650acb08..05f606d3745 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,3 +1,4 @@
+----------------------------------------------------------------------------------------------------------------
 ### Description
 
 <!--
@@ -7,6 +8,7 @@
 -->
 
 
+----------------------------------------------------------------------------------------------------------------
 ### Pull request type
 
 <!--
@@ -16,17 +18,23 @@
     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.
 -->
-    [ ] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
-    [ ] Feature update (New feature / Functionality change / New API)
-    [ ] Major update (Breaking change E.g. Return code change / API behaviour change)
+    [] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
+    [] Feature update (New feature / Functionality change / New API)
+    [] Major update (Breaking change E.g. Return code change / API behaviour change)
 
+----------------------------------------------------------------------------------------------------------------
 ### Test results 
 
 <!--
     Optional
     For example, add test results for new target
 -->
-
+    [] No Tests required for this change
+    [] These PR changes will be covered by existing tests and CI
+    [] Tests supplied below
+    
+    
+----------------------------------------------------------------------------------------------------------------
 ### Reviewers
 
 <!--
@@ -34,6 +42,7 @@
     Request additional reviewers with @username
 -->
 
+----------------------------------------------------------------------------------------------------------------
 ### Release Notes
 
 <!--
@@ -48,4 +57,5 @@
 
 ##### Migration actions required
 
+----------------------------------------------------------------------------------------------------------------
 

From 1725d5bdef3754ea7e2cf2210dfb882aa8e7bb2a Mon Sep 17 00:00:00 2001
From: Anna Bridge <Anna.Bridge@arm.com>
Date: Wed, 25 Sep 2019 16:05:35 +0100
Subject: [PATCH 3/6] Add addional guidance

---
 .github/pull_request_template.md | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 05f606d3745..5bfa8b41ea2 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,5 +1,9 @@
+<!--
+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#pull-request-types).
+-->
+
 ----------------------------------------------------------------------------------------------------------------
-### Description
+### Description (Required)
 
 <!--
     Required
@@ -9,7 +13,7 @@
 
 
 ----------------------------------------------------------------------------------------------------------------
-### Pull request type
+### Pull request type (Required)
 
 <!--
     Required
@@ -23,11 +27,11 @@
     [] Major update (Breaking change E.g. Return code change / API behaviour change)
 
 ----------------------------------------------------------------------------------------------------------------
-### Test results 
+### Test results (Required)
 
 <!--
-    Optional
-    For example, add test results for new target
+    Required
+    Please add a 'x' to just one of the following sections
 -->
     [] No Tests required for this change
     [] These PR changes will be covered by existing tests and CI
@@ -35,7 +39,7 @@
     
     
 ----------------------------------------------------------------------------------------------------------------
-### Reviewers
+### Reviewers (Optional)
 
 <!--
     Optional
@@ -43,7 +47,7 @@
 -->
 
 ----------------------------------------------------------------------------------------------------------------
-### Release Notes
+### Release Notes (Reguired for Feature/Major PRs)
 
 <!--
     This section is compulsory for all Feature and Major PR types.

From 580af4e4d2908746d0d737d72c120028a78b2664 Mon Sep 17 00:00:00 2001
From: Anna Bridge <Anna.Bridge@arm.com>
Date: Wed, 25 Sep 2019 16:14:18 +0100
Subject: [PATCH 4/6] Improve formatting

Made required/optional italic and removed a couple of superfluous lines
---
 .github/pull_request_template.md | 17 +++++++----------
 1 file changed, 7 insertions(+), 10 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 5bfa8b41ea2..e75162ceeb8 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,9 +1,7 @@
 <!--
 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#pull-request-types).
 -->
-
-----------------------------------------------------------------------------------------------------------------
-### Description (Required)
+### Description (*required*)
 
 <!--
     Required
@@ -13,7 +11,7 @@ For more information on the requirements for pull requests, please see [the cont
 
 
 ----------------------------------------------------------------------------------------------------------------
-### Pull request type (Required)
+### Pull request type (*required*)
 
 <!--
     Required
@@ -27,11 +25,11 @@ For more information on the requirements for pull requests, please see [the cont
     [] Major update (Breaking change E.g. Return code change / API behaviour change)
 
 ----------------------------------------------------------------------------------------------------------------
-### Test results (Required)
+### Test results (*required*)
 
 <!--
-    Required
-    Please add a 'x' to just one of the following sections
+    Optional
+    For example, add test results for new target
 -->
     [] No Tests required for this change
     [] These PR changes will be covered by existing tests and CI
@@ -39,7 +37,7 @@ For more information on the requirements for pull requests, please see [the cont
     
     
 ----------------------------------------------------------------------------------------------------------------
-### Reviewers (Optional)
+### Reviewers (*optional*)
 
 <!--
     Optional
@@ -47,7 +45,7 @@ For more information on the requirements for pull requests, please see [the cont
 -->
 
 ----------------------------------------------------------------------------------------------------------------
-### Release Notes (Reguired for Feature/Major PRs)
+### Release Notes (*required for feature/major PRs*)
 
 <!--
     This section is compulsory for all Feature and Major PR types.
@@ -61,5 +59,4 @@ For more information on the requirements for pull requests, please see [the cont
 
 ##### Migration actions required
 
-----------------------------------------------------------------------------------------------------------------
 

From f8dc87c5ba548d1fa6591092d2dc7f1da59730ef Mon Sep 17 00:00:00 2001
From: Anna Bridge <Anna.Bridge@arm.com>
Date: Thu, 26 Sep 2019 11:55:51 +0100
Subject: [PATCH 5/6] Add clarity to description and reword tests options

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

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index e75162ceeb8..435730ac090 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -8,8 +8,11 @@ For more information on the requirements for pull requests, please see [the cont
     Add here detailed changes summary, testing results, dependencies
     Good example: https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html (Pull request template)
 -->
+##### Summary of change (*What the change is for and why*)
 
 
+##### Documentation (*Details of any document updates required*)
+
 ----------------------------------------------------------------------------------------------------------------
 ### Pull request type (*required*)
 
@@ -28,12 +31,12 @@ For more information on the requirements for pull requests, please see [the cont
 ### Test results (*required*)
 
 <!--
-    Optional
+    Required
     For example, add test results for new target
 -->
-    [] No Tests required for this change
-    [] These PR changes will be covered by existing tests and CI
-    [] Tests supplied below
+    [] No Tests required for this change (E.g docs only update)
+    [] Covered by existing mbed-os tests (Greentea or Unittest)
+    [] Tests / results supplied as part of this PR
     
     
 ----------------------------------------------------------------------------------------------------------------
@@ -60,3 +63,4 @@ For more information on the requirements for pull requests, please see [the cont
 ##### Migration actions required
 
 
+

From 7349001547e0ddc6c1c0e959d389c52e161c60d9 Mon Sep 17 00:00:00 2001
From: Anna Bridge <Anna.Bridge@arm.com>
Date: Thu, 26 Sep 2019 14:54:03 +0100
Subject: [PATCH 6/6] Clarify release note section requirements

---
 .github/pull_request_template.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 435730ac090..3cdc42f6b4d 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -51,7 +51,7 @@ For more information on the requirements for pull requests, please see [the cont
 ### Release Notes (*required for feature/major PRs*)
 
 <!--
-    This section is compulsory for all Feature and Major PR types.
+    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). 
 -->