ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #11920 from ARMmbed/pr_template 

Simplify pull request template headers and instructions
pull/12022/head
Martin Kojtal 2019-12-03 15:53:21 +01:00 committed by GitHub
parent e4e6ac5bd6 fa02380b22
commit 888dfffabf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 42 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
.github/pull_request_template.md vendored
View File

@ -1,25 +1,57 @@
<!--
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).
NOTE: Do not remove any of the template headings (even for optional sections) as this
template is automatically parsed.
-->
### Description
#### Summary of change <!-- Required -->
### Summary of changes <!-- Required -->
<!-- Basic information about the change: what the change is for, why do we need it any implications -->
<!--
Please provide the following information:
#### Documentation <!-- Optional, but most likely you need it -->
Description of the the change (what is this fixing / adding / removing?).
<!-- Details of any document updates required, including links to PR against the docs repository -->
Why the change is needed (if this is fixing a reported issue please summarize what
the issue is and add the reference. E.g. Fixes #17119).
NOTE: This section is automatically written to release notes for Feature and
Major releases and should contain enough details for a user.
-->
#### Impact of changes <!-- Optional -->
<!--
If there are any implications for users taking this change then they must be
provided here. For Major PR types this field is MANDATORY.
NOTE: This section is automatically written to release notes for Feature and
Major releases and should contain enough details for a user.
-->
#### Migration actions required <!-- Optional -->
<!--
This should only be applicable in Major PR types for which this field is MANDATORY.
NOTE: This section is automatically written to release notes for Feature and
Major releases and should contain enough details for a user.
-->
### Documentation <!-- Required -->
<!--
Please provide details of any document updates required, including links to any
related PRs against the docs repository.
If no document updates are required please specify 'None', this at least tells us
that this has been considered.
-->
----------------------------------------------------------------------------------------------------------------
### Pull request type <!-- Required -->
<!--
Required
Please add only one X to one of the following types. Do not fill multiple types (split the pull request otherwise).
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. The only changes to be made are to add a description text under the
description heading and to add a 'x' to the correct box.
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.
-->
[] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] 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
### Test results <!-- Required -->
<!--
Required
Provide all the information required, listing all the testing performed. For new targets please attach full test results
for all supported compilers.
Provide all the information required, listing all the testing performed. For new targets please attach full test results for all supported compilers.
-->
[] No Tests required for this change (E.g docs only update)
[] 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
### Reviewers <!-- Optional -->
<!--
Optional
Request additional reviewers with @username or @team
-->
----------------------------------------------------------------------------------------------------------------
### Release Notes <!-- Required for features, deprecations, breaking changes and other major PRs -->
<!--
All 3 sections are compulsory for Major PR types. For Feature PRs only the summary section is required.
This section is automatically added to release notes. Please fill in each sub-section with sufficient detail for a user.
For more information, please see [the contributing guidelines](https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html#pull-request-types).
-->
#### Summary of changes
#### Impact of changes
#### Migration actions required