Simplify pull request template headers and instructions #11920
Conversation
There is confusion with having sub headings below Description. This commit removes teh Description header completely and promotes sub headings to full headings. Some of the notes under each heading have also been updated to provide better clarity.
adbridge
changed the title
|
@adbridge, thank you for your changes. |
Feedback has shown that having similar fields in the release notes section to the main headings is confusing. This PR simplifies the sections and removes the release notes section completely. Changes will be required to the release scripts and the docs to reflect these changes.
.github/pull_request_template.md
Outdated
| 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). | ||
|
|
||
| Any implications for users taking this change. |
There was a problem hiding this comment.
That's repeated in the next point
.github/pull_request_template.md
Outdated
|
|
||
| --> | ||
|
|
||
| ### Impact of changes <!-- Optional --> |
There was a problem hiding this comment.
When looking at rendered text, this is the same as summary of changes ( using ###) , would it be better as this is option to be done with one less (####) ? As these two (migration, impact) are optional most of the time.
Wouldn't this be the same in the release notes? Summary of changes as the main text, subsections in there are migration action and impact?
There was a problem hiding this comment.
We could do that yes
adbridge
added
the
release-version: 6.0.0-alpha-1
|
@adbridge As 5.15 branch was created, can this land now? CI started |
Should be ok yes |
Template updated here to show what the new one will look like:
Summary of changes
There is confusion with having sub headings below Description and duplication of fields between
main description and release notes section.
This PR removes the Description header completely and promotes
sub headings to full headings. It also removes the release notes section completely and promotes the implication and migration sections.
Some of the notes under each heading have also been updated to
provide better clarity.
Impact of changes
Mbed-release script will require updates to allow for new format.
Migration actions required
Documentation
https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html will require updates
Pull request type
Test results
Reviewers