Add release notes section to PR template #9713
Conversation
|
I think this is a fantastic idea. I hope you don't mind - I've copy edited this and added a link to the relevant documentation. |
|
@orenc17, thank you for your changes. |
|
The user(s) have spoken! Tbh, I thought this was already added. Looking for OKs from other @ARMmbed/mbed-os-maintainers |
.github/pull_request_template.md
Outdated
| ### Release Notes | ||
| <!-- | ||
| Optional | ||
| In case of breaking changes, functionality changes or refactors, plase 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). |
There was a problem hiding this comment.
@adbridge Just to check to have this implemented - we documented in docs that any functional change, but rather as it's here that even bigger refactors or breaking change (it's functionality change but has it's own item) can have release notes, would make this requirement: script should check any PR for release notes and fetch them.
There was a problem hiding this comment.
plase add
Should say 'please add'
.github/pull_request_template.md
Outdated
| ### Release Notes | ||
| <!-- | ||
| Optional | ||
| In case of breaking changes, functionality changes or refactors, plase 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). |
There was a problem hiding this comment.
plase add
Should say 'please add'
|
Good catch @adbridge |
|
CI started |
Description
Never miss your release notes again
Pull request type
Reviewers
@ARMmbed/mbed-os-maintainers @AnotherButler
Release Notes