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

41 lines
1.2 KiB
Markdown
Raw Normal View History

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
### Description
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
### Pull request type
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.
-->
[ ] Fix
PR template: do not use task list
2018-03-20 11:56:03 +00:00
[ ] Refactor
PR template: fix target update list Not only new target, any target update goes to own section. This covers target updates to SDK, HAL implementation, target list, etc. All these go to patch releases.
2018-08-03 08:57:00 +00:00
[ ] Target update
PR template: Feature -> functionality change Feature might be misinterpreted in some cases. This label should be about functionality in backward compatible way. That means that this is either deprecating some current one or adding new functionality. Functionality change should cover: - adding configuration - deprecating functionality - adding new functionality This change would go automatically to feature release.
2018-08-08 11:50:12 +00:00
[ ] Functionality change
PR template: add "docs update" As we know have documentation in the repository, this type should define changes only to documentation.
2018-09-25 08:30:58 +00:00
[ ] Docs update
PR template: add "test update" Adding new test case, test unit or just updating tests
2018-09-25 13:11:39 +00:00
[ ] Test update
PR template: do not use task list
2018-03-20 11:56:03 +00:00
[ ] Breaking change
initial github issue and PR templates
2016-08-09 07:39:18 +00:00
github: add reviewers to the PR template Use @mention to request specific reviewers.
2018-12-19 09:34:34 +00:00
### Reviewers
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 release notes section to PR template
2019-02-13 19:09:33 +00:00
### Release Notes
<!--
Optional
In case of breaking changes, functionality changes or refactors, please add release notes here.
For more information, please see [the contributing guidelines](https://os.mbed.com/docs/mbed-os/latest/contributing /workflow.html#pull-request-types).
-->