You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+23-13Lines changed: 23 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,38 @@
1
1
<!--
2
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).
3
+
4
+
NOTE: Do not remove any of the template headings (even for optional sections) as this
5
+
template is automatically parsed.
3
6
-->
4
7
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?).
7
14
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).
9
17
10
-
#### Documentation <!-- Optional, but most likely you need it -->
18
+
Any implications for users taking this change.
19
+
-->
11
20
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
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.
0 commit comments