Skip to content

Commit 888dfff

Browse files
authored
Merge pull request #11920 from ARMmbed/pr_template
Simplify pull request template headers and instructions
2 parents e4e6ac5 + fa02380 commit 888dfff

File tree

1 file changed

+42
-26
lines changed

1 file changed

+42
-26
lines changed

.github/pull_request_template.md

Lines changed: 42 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,57 @@
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.
6+
-->
7+
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?).
14+
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).
17+
18+
NOTE: This section is automatically written to release notes for Feature and
19+
Major releases and should contain enough details for a user.
20+
321
-->
422

5-
### Description
6-
#### Summary of change <!-- Required -->
23+
#### Impact of changes <!-- Optional -->
24+
<!--
25+
If there are any implications for users taking this change then they must be
26+
provided here. For Major PR types this field is MANDATORY.
727
8-
<!-- Basic information about the change: what the change is for, why do we need it any implications -->
28+
NOTE: This section is automatically written to release notes for Feature and
29+
Major releases and should contain enough details for a user.
30+
-->
931

10-
#### Documentation <!-- Optional, but most likely you need it -->
32+
#### Migration actions required <!-- Optional -->
33+
<!--
34+
This should only be applicable in Major PR types for which this field is MANDATORY.
1135
12-
<!-- Details of any document updates required, including links to PR against the docs repository -->
36+
NOTE: This section is automatically written to release notes for Feature and
37+
Major releases and should contain enough details for a user.
38+
-->
39+
40+
### Documentation <!-- Required -->
41+
42+
<!--
43+
Please provide details of any document updates required, including links to any
44+
related PRs against the docs repository.
45+
If no document updates are required please specify 'None', this at least tells us
46+
that this has been considered.
47+
-->
1348

1449
----------------------------------------------------------------------------------------------------------------
1550
### Pull request type <!-- Required -->
1651

1752
<!--
18-
Required
1953
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.
54+
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.
2355
-->
2456
[] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
2557
[] Feature update (New feature / Functionality change / New API)
@@ -29,9 +61,7 @@ For more information on the requirements for pull requests, please see [the cont
2961
### Test results <!-- Required -->
3062

3163
<!--
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.
64+
Provide all the information required, listing all the testing performed. For new targets please attach full test results for all supported compilers.
3565
-->
3666
[] No Tests required for this change (E.g docs only update)
3767
[] Covered by existing mbed-os tests (Greentea or Unittest)
@@ -42,21 +72,7 @@ For more information on the requirements for pull requests, please see [the cont
4272
### Reviewers <!-- Optional -->
4373

4474
<!--
45-
Optional
4675
Request additional reviewers with @username or @team
4776
-->
4877

4978
----------------------------------------------------------------------------------------------------------------
50-
### Release Notes <!-- Required for features, deprecations, breaking changes and other major PRs -->
51-
52-
<!--
53-
All 3 sections are compulsory for Major PR types. For Feature PRs only the summary section is required.
54-
This section is automatically added to release notes. Please fill in each sub-section with sufficient detail for a user.
55-
For more information, please see [the contributing guidelines](https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html#pull-request-types).
56-
-->
57-
58-
#### Summary of changes
59-
60-
#### Impact of changes
61-
62-
#### Migration actions required

0 commit comments

Comments
 (0)