Skip to content

Commit e5a728f

Browse files
authored
Merge pull request #11563 from adbridge/master
Simplify pull request template
2 parents a44fd82 + 7349001 commit e5a728f

File tree

1 file changed

+40
-14
lines changed

1 file changed

+40
-14
lines changed

.github/pull_request_template.md

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
1-
### Description
1+
<!--
2+
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).
3+
-->
4+
### Description (*required*)
25

36
<!--
47
Required
58
Add here detailed changes summary, testing results, dependencies
69
Good example: https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html (Pull request template)
710
-->
11+
##### Summary of change (*What the change is for and why*)
812

913

10-
### Pull request type
14+
##### Documentation (*Details of any document updates required*)
15+
16+
----------------------------------------------------------------------------------------------------------------
17+
### Pull request type (*required*)
1118

1219
<!--
1320
Required
@@ -16,25 +23,44 @@
1623
of them would change the meaning incorrectly. The only changes to be made are to add a description text under the
1724
description heading and to add a 'x' to the correct box.
1825
-->
19-
[ ] Fix
20-
[ ] Refactor
21-
[ ] Target update
22-
[ ] Functionality change
23-
[ ] Docs update
24-
[ ] Test update
25-
[ ] Breaking change
26+
[] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
27+
[] Feature update (New feature / Functionality change / New API)
28+
[] Major update (Breaking change E.g. Return code change / API behaviour change)
29+
30+
----------------------------------------------------------------------------------------------------------------
31+
### Test results (*required*)
2632

27-
### Reviewers
33+
<!--
34+
Required
35+
For example, add test results for new target
36+
-->
37+
[] No Tests required for this change (E.g docs only update)
38+
[] Covered by existing mbed-os tests (Greentea or Unittest)
39+
[] Tests / results supplied as part of this PR
40+
41+
42+
----------------------------------------------------------------------------------------------------------------
43+
### Reviewers (*optional*)
2844

2945
<!--
3046
Optional
3147
Request additional reviewers with @username
3248
-->
3349

34-
### Release Notes
50+
----------------------------------------------------------------------------------------------------------------
51+
### Release Notes (*required for feature/major PRs*)
3552

3653
<!--
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).
54+
All 3 sections are compulsory for Major PR types. For Feature PRs only the summary section is required.
55+
This section is automatically added to release notes. Please fill in each sub-section with sufficient detail for a user.
56+
For more information, please see [the contributing guidelines](https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html#pull-request-types).
4057
-->
58+
59+
##### Summary of changes
60+
61+
##### Impact of changes
62+
63+
##### Migration actions required
64+
65+
66+

0 commit comments

Comments
 (0)