Skip to content

Commit 3f2fd47

Browse files
committed
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.
1 parent 2bde658 commit 3f2fd47

File tree

1 file changed

+23
-13
lines changed

1 file changed

+23
-13
lines changed

.github/pull_request_template.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,38 @@
11
<!--
22
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).
3+
4+
NOTE: Do not remove any of the template headings (even for optional sections) as this
5+
template is automatically parsed.
36
-->
47

5-
### Description
6-
#### Summary of change <!-- Required -->
8+
### Summary of changes <!-- Required -->
9+
10+
<!--
11+
Please provide the following information:
12+
13+
Description of the the change (what is this fixing / adding / removing?).
714
8-
<!-- Basic information about the change: what the change is for, why do we need it any implications -->
15+
Why the change is needed (if this is fixing a reported issue please summarize what
16+
the issue is and add the reference. E.g. Fixes #17119).
917
10-
#### Documentation <!-- Optional, but most likely you need it -->
18+
Any implications for users taking this change.
19+
-->
1120

12-
<!-- Details of any document updates required, including links to PR against the docs repository -->
21+
### Documentation <!-- Required -->
22+
23+
<!--
24+
Please provide details of any document updates required, including links to any
25+
related PRs against the docs repository.
26+
If no document updates are required please specify 'None', this at least tells us
27+
that this has been considered.
28+
-->
1329

1430
----------------------------------------------------------------------------------------------------------------
1531
### Pull request type <!-- Required -->
1632

1733
<!--
18-
Required
1934
Please add only one X to one of the following types. Do not fill multiple types (split the pull request otherwise).
20-
Please note this is not a GitHub task list, indenting the boxes or changing the format to add a '.' or '*' in front
21-
of them would change the meaning incorrectly. The only changes to be made are to add a description text under the
22-
description heading and to add a 'x' to the correct box.
35+
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.
2336
-->
2437
[] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
2538
[] 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
2942
### Test results <!-- Required -->
3043

3144
<!--
32-
Required
33-
Provide all the information required, listing all the testing performed. For new targets please attach full test results
34-
for all supported compilers.
45+
Provide all the information required, listing all the testing performed. For new targets please attach full test results for all supported compilers.
3546
-->
3647
[] No Tests required for this change (E.g docs only update)
3748
[] 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
4253
### Reviewers <!-- Optional -->
4354

4455
<!--
45-
Optional
4656
Request additional reviewers with @username or @team
4757
-->
4858

0 commit comments

Comments
 (0)