Skip to content

Commit 2127b45

Browse files
committed
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.
1 parent ab857c4 commit 2127b45

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

.github/pull_request_template.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,16 @@
1616
of them would change the meaning incorrectly. The only changes to be made are to add a description text under the
1717
description heading and to add a 'x' to the correct box.
1818
-->
19-
[ ] Fix
20-
[ ] Refactor
21-
[ ] Target update
22-
[ ] Functionality change
23-
[ ] Docs update
24-
[ ] Test update
25-
[ ] Breaking change
19+
[ ] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
20+
[ ] Feature update (New feature / Functionality change / New API)
21+
[ ] Major update (Breaking change E.g. Return code change / API behaviour change)
22+
23+
### Test results
24+
25+
<!--
26+
Optional
27+
For example, add test results for new target
28+
-->
2629

2730
### Reviewers
2831

@@ -34,7 +37,15 @@
3437
### Release Notes
3538

3639
<!--
37-
Optional
38-
In case of breaking changes, functionality changes or refactors, please add release notes here.
39-
For more information, please see [the contributing guidelines](https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html#pull-request-types).
40+
This section is compulsory for all Feature and Major PR types.
41+
This section is automatically added to release notes. Please fill in each sub-section with sufficient detail for a user.
42+
For more information, please see [the contributing guidelines](https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html#pull-request-types).
4043
-->
44+
45+
##### Summary of changes
46+
47+
##### Impact of changes
48+
49+
##### Migration actions required
50+
51+

0 commit comments

Comments
 (0)