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.

Sign up for GitHub

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

Jump to bottom

Simplify pull request template #11563

Merged
merged 6 commits into from Oct 25, 2019
Merged

Simplify pull request template #11563

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2127b45
Simplify pull request template
adbridge Sep 25, 2019
4e505f6
Add test results section
adbridge Sep 25, 2019
1725d5b
Add addional guidance
adbridge Sep 25, 2019
580af4e
Improve formatting
adbridge Sep 25, 2019
f8dc87c
Add clarity to description and reword tests options
adbridge Sep 26, 2019
7349001
Clarify release note section requirements
adbridge Sep 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
54 changes: 40 additions & 14 deletions .github/pull_request_template.md
View file
Open in desktop
@@ -1,13 +1,20 @@
### Description
<!--
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).
-->
### Description (*required*)

<!--
Required
Add here detailed changes summary, testing results, dependencies
Good example: https://os.mbed.com/docs/mbed-os/latest/contributing/workflow.html (Pull request template)
-->
##### Summary of change (*What the change is for and why*)


### Pull request type
##### Documentation (*Details of any document updates required*)

----------------------------------------------------------------------------------------------------------------
### Pull request type (*required*)

<!--
Required
Expand All @@ -16,25 +23,44 @@
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
[ ] Refactor
[ ] Target update
[ ] Functionality change
[ ] Docs update
[ ] Test update
[ ] Breaking change
[] 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)

----------------------------------------------------------------------------------------------------------------
### Test results (*required*)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So is it required or optional? It says required in line 28 and optional in 30

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Required should be updated, I thought I had changed line 30 in the last update - will check


### Reviewers
<!--
Required
For example, add test results for new target
-->
[] No Tests required for this change (E.g docs only update)
[] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR


----------------------------------------------------------------------------------------------------------------
### Reviewers (*optional*)

<!--
Optional
Request additional reviewers with @username
-->

### Release Notes
----------------------------------------------------------------------------------------------------------------
### Release Notes (*required for feature/major PRs*)

<!--
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).
All 3 sections are compulsory for Major PR types. For Feature PRs only the summary section is required.
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).
-->

##### Summary of changes

##### Impact of changes

##### Migration actions required