Merge pull request #1035 from j0n3lson/doc-update-pr-template
Use a more k8s/release friendly PR template.
This commit is contained in:
commit
0a97fd4acc
59
.github/pull_request_template.md
vendored
59
.github/pull_request_template.md
vendored
@ -4,38 +4,44 @@
|
|||||||
If a section of the PR template does not apply to this PR, then delete that section.
|
If a section of the PR template does not apply to this PR, then delete that section.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## Motivation
|
## What type of PR is this?
|
||||||
|
|
||||||
_(fill-in or delete this section)_
|
_(REQUIRED)_
|
||||||
|
|
||||||
|
- [ ] bug
|
||||||
|
- [ ] cleanup
|
||||||
|
- [ ] documentation
|
||||||
|
- [ ] feature
|
||||||
|
|
||||||
|
## What this PR does / why we need it:
|
||||||
|
|
||||||
|
_(REQUIRED)_
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
What goal is this change working towards?
|
What goal is this change working towards?
|
||||||
|
Provide a bullet pointed summary of how each file was changed.
|
||||||
|
Briefly explain any decisions you made with respect to the changes.
|
||||||
|
Include anything here that you didn't include in *Release Notes*
|
||||||
|
above, such as changes to CI or changes to internal methods.
|
||||||
|
-->
|
||||||
|
|
||||||
|
## Which issue(s) this PR fixes:
|
||||||
|
|
||||||
|
_(REQUIRED)_
|
||||||
|
<!--
|
||||||
If this PR fixes one of more issues, list them here.
|
If this PR fixes one of more issues, list them here.
|
||||||
One line each, like so:
|
One line each, like so:
|
||||||
Fixes #123
|
Fixes #123
|
||||||
Fixes #39
|
Fixes #39
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## Release Notes
|
## Special notes for your reviewer:
|
||||||
|
|
||||||
_(fill-in or delete this section)_
|
_(fill-in or delete this section)_
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
If this PR makes user facing changes, please describe them here.
|
Is there any particular feedback you would / wouldn't like?
|
||||||
This description will be copied into the release notes, whenever
|
Which parts of the code should reviewers focus on?
|
||||||
the next version is released. Keep this section short, and
|
|
||||||
focus on high level changes.
|
|
||||||
-->
|
|
||||||
|
|
||||||
## Changes
|
|
||||||
|
|
||||||
_(fill-in or delete this section)_
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Provide a bullet pointed summary of how each file was changed.
|
|
||||||
Briefly explain any decisions you made with respect to the changes.
|
|
||||||
Include anything here that you didn't include in *Release Notes*
|
|
||||||
above, such as changes to CI or changes to internal methods.
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
@ -46,11 +52,18 @@ _(fill-in or delete this section)_
|
|||||||
Describe how you tested this change.
|
Describe how you tested this change.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## Reviewer Guidelines
|
## Release Notes
|
||||||
|
|
||||||
_(fill-in or delete this section)_
|
|
||||||
|
|
||||||
|
_(REQUIRED)_
|
||||||
<!--
|
<!--
|
||||||
Is there any particular feedback you would / wouldn't like?
|
If this PR makes user facing changes, please describe them here. This
|
||||||
Which parts of the code should reviewers focus on?
|
description will be copied into the release notes/changelog, whenever the
|
||||||
|
next version is released. Keep this section short, and focus on high level
|
||||||
|
changes.
|
||||||
|
|
||||||
|
Put your text between the block. To omit notes, use NONE within the block.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
```release-note
|
||||||
|
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user