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

63 lines
2.4 KiB
Markdown
Raw Normal View History

Add addional guidance
2019-09-25 15:05:35 +00:00
<!--
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).
-->
Improve formatting Made required/optional italic and removed a couple of superfluous lines
2019-09-25 15:14:18 +00:00
### Description (*required*)
initial github issue and PR templates
2016-08-09 07:39:18 +00:00
Add release notes section to PR template
2019-02-13 19:09:33 +00:00
<!--
pull request: add required info Please use these 2 sections for describing a pull request. They should be part of every pull request. The type specifies what is expected from the pull request and when it can be released. For instance a feature pull request can't be expected to go to the patch release. Important: do not mix pull request types ! Changed also the heading type, to make it smaller.
2018-02-27 15:40:24 +00:00
Required
Add release notes section to PR template
2019-02-13 19:09:33 +00:00
Add here detailed changes summary, testing results, dependencies
Fix links to documentation on https://os.mbed.com
2019-01-21 21:49:48 +00:00
Good example: https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html (Pull request template)
pull request: add required info Please use these 2 sections for describing a pull request. They should be part of every pull request. The type specifies what is expected from the pull request and when it can be released. For instance a feature pull request can't be expected to go to the patch release. Important: do not mix pull request types ! Changed also the heading type, to make it smaller.
2018-02-27 15:40:24 +00:00
-->
small updates
2016-08-31 12:08:51 +00:00
pull request: add required info Please use these 2 sections for describing a pull request. They should be part of every pull request. The type specifies what is expected from the pull request and when it can be released. For instance a feature pull request can't be expected to go to the patch release. Important: do not mix pull request types ! Changed also the heading type, to make it smaller.
2018-02-27 15:40:24 +00:00
Add test results section Also add section separators
2019-09-25 14:38:53 +00:00
----------------------------------------------------------------------------------------------------------------
Improve formatting Made required/optional italic and removed a couple of superfluous lines
2019-09-25 15:14:18 +00:00
### Pull request type (*required*)
pull request: add required info Please use these 2 sections for describing a pull request. They should be part of every pull request. The type specifies what is expected from the pull request and when it can be released. For instance a feature pull request can't be expected to go to the patch release. Important: do not mix pull request types ! Changed also the heading type, to make it smaller.
2018-02-27 15:40:24 +00:00
Add release notes section to PR template
2019-02-13 19:09:33 +00:00
<!--
pull request: add required info Please use these 2 sections for describing a pull request. They should be part of every pull request. The type specifies what is expected from the pull request and when it can be released. For instance a feature pull request can't be expected to go to the patch release. Important: do not mix pull request types ! Changed also the heading type, to make it smaller.
2018-02-27 15:40:24 +00:00
Required
make PR type box list "fancier" without making it a github tasklist
2018-04-18 13:40:17 +00:00
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.
-->
Add test results section Also add section separators
2019-09-25 14:38:53 +00:00
[] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[] Major update (Breaking change E.g. Return code change / API behaviour change)
Simplify pull request template Condense multiple options into the main three and summarise what can go into those 3 types. Add a test results section. Add compulsory sections to Release Notes.
2019-09-25 10:55:00 +00:00
Add test results section Also add section separators
2019-09-25 14:38:53 +00:00
----------------------------------------------------------------------------------------------------------------
Improve formatting Made required/optional italic and removed a couple of superfluous lines
2019-09-25 15:14:18 +00:00
### Test results (*required*)
Simplify pull request template Condense multiple options into the main three and summarise what can go into those 3 types. Add a test results section. Add compulsory sections to Release Notes.
2019-09-25 10:55:00 +00:00
<!--
Improve formatting Made required/optional italic and removed a couple of superfluous lines
2019-09-25 15:14:18 +00:00
Optional
For example, add test results for new target
Simplify pull request template Condense multiple options into the main three and summarise what can go into those 3 types. Add a test results section. Add compulsory sections to Release Notes.
2019-09-25 10:55:00 +00:00
-->
Add test results section Also add section separators
2019-09-25 14:38:53 +00:00
[] No Tests required for this change
[] These PR changes will be covered by existing tests and CI
[] Tests supplied below
----------------------------------------------------------------------------------------------------------------
Improve formatting Made required/optional italic and removed a couple of superfluous lines
2019-09-25 15:14:18 +00:00
### Reviewers (*optional*)
github: add reviewers to the PR template Use @mention to request specific reviewers.
2018-12-19 09:34:34 +00:00
Add release notes section to PR template
2019-02-13 19:09:33 +00:00
<!--
github: add reviewers to the PR template Use @mention to request specific reviewers.
2018-12-19 09:34:34 +00:00
Optional
Make minor change in pull_request_template.md Fix nit for precise language
2018-12-19 16:46:59 +00:00
Request additional reviewers with @username
github: add reviewers to the PR template Use @mention to request specific reviewers.
2018-12-19 09:34:34 +00:00
-->
Add test results section Also add section separators
2019-09-25 14:38:53 +00:00
----------------------------------------------------------------------------------------------------------------
Improve formatting Made required/optional italic and removed a couple of superfluous lines
2019-09-25 15:14:18 +00:00
### Release Notes (*required for feature/major PRs*)
Add release notes section to PR template
2019-02-13 19:09:33 +00:00
<!--
Simplify pull request template Condense multiple options into the main three and summarise what can go into those 3 types. Add a test results section. Add compulsory sections to Release Notes.
2019-09-25 10:55:00 +00:00
This section is compulsory for all Feature and Major PR types.
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).
Add release notes section to PR template
2019-02-13 19:09:33 +00:00
-->
Simplify pull request template Condense multiple options into the main three and summarise what can go into those 3 types. Add a test results section. Add compulsory sections to Release Notes.
2019-09-25 10:55:00 +00:00
##### Summary of changes
##### Impact of changes
##### Migration actions required