Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release notes section to PR template #9713

Merged
merged 1 commit into from Feb 14, 2019

Conversation

Projects
None yet
7 participants
@orenc17
Copy link
Contributor

orenc17 commented Feb 13, 2019

Description

Never miss your release notes again

Pull request type

[X] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[ ] Docs update
[ ] Test update
[ ] Breaking change

Reviewers

@ARMmbed/mbed-os-maintainers @AnotherButler

Release Notes

@AnotherButler

This comment has been minimized.

Copy link
Contributor

AnotherButler commented Feb 13, 2019

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.

@ciarmcom ciarmcom requested review from AnotherButler and ARMmbed/mbed-os-maintainers Feb 13, 2019

@ciarmcom

This comment has been minimized.

Copy link
Member

ciarmcom commented Feb 13, 2019

@orenc17, thank you for your changes.
@AnotherButler @ARMmbed/mbed-os-maintainers please review.

@cmonr

cmonr approved these changes Feb 13, 2019

@cmonr

This comment has been minimized.

Copy link
Contributor

cmonr commented Feb 13, 2019

The user(s) have spoken!

Tbh, I thought this was already added. Looking for OKs from other @ARMmbed/mbed-os-maintainers

@0xc0170
Copy link
Member

0xc0170 left a comment

Thanks ! we were going to add this, should be in ! 👍

One small cosmetic edit, please add space as other sections has it (after header , one empty line).

.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).

This comment has been minimized.

@0xc0170

0xc0170 Feb 14, 2019

Member

@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.

This comment has been minimized.

@adbridge

adbridge Feb 14, 2019

Contributor

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).

This comment has been minimized.

@adbridge

adbridge Feb 14, 2019

Contributor

plase add

Should say 'please add'

@orenc17 orenc17 force-pushed the kfnta:pr-template branch to 3762990 Feb 14, 2019

@AnotherButler

This comment has been minimized.

Copy link
Contributor

AnotherButler commented Feb 14, 2019

Good catch @adbridge
Thanks 👍

@cmonr

This comment has been minimized.

Copy link
Contributor

cmonr commented Feb 14, 2019

CI started

@cmonr cmonr added ready for merge and removed needs: CI labels Feb 14, 2019

@cmonr cmonr merged commit c3229ee into ARMmbed:master Feb 14, 2019

15 checks passed

continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
travis-ci/astyle Local astyle testing has passed
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/doxy-spellcheck Local doxy-spellcheck testing has passed
Details
travis-ci/events Passed, runtime is 9184 cycles
Details
travis-ci/gitattributestest Local gitattributestest testing has passed
Details
travis-ci/include_check Local include_check testing has passed
Details
travis-ci/licence_check Local licence_check testing has passed
Details
travis-ci/littlefs Passed, code size is 8408B
Details
travis-ci/psa-autogen Local psa-autogen testing has passed
Details
travis-ci/tools-py2.7 Local tools-py2.7 testing has passed
Details
travis-ci/tools-py3.5 Local tools-py3.5 testing has passed
Details
travis-ci/tools-py3.6 Local tools-py3.6 testing has passed
Details
travis-ci/tools-py3.7 Local tools-py3.7 testing has passed
Details

@cmonr cmonr removed the ready for merge label Feb 14, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.