Iterate on pull request template.
- Moves the "front matter" to a Markdown comment so you don't necessarily have to delete it. - Reduces a little bit of boilerplate (this is a bit subjective). - Tweaks some formatting (also subjective). - Describe what happens when you use "Fixes [...]". - Tweak the release note block so it should be easier to parse out automatically (using the same syntax as Kubernetes). Signed-off-by: Matt Moyer <moyerm@vmware.com>
This commit is contained in:
parent
7eed7ba19a
commit
01153dcb9d
29
.github/pull_request_template.md
vendored
29
.github/pull_request_template.md
vendored
@ -1,3 +1,4 @@
|
||||
<!--
|
||||
Thank you for submitting a pull request for Pinniped!
|
||||
|
||||
Before submitting, please see the guidelines in CONTRIBUTING.md in this repo.
|
||||
@ -11,18 +12,30 @@ Reminder: Did you remember to run all the linter, unit tests, and integration te
|
||||
described in CONTRIBUTING.md on your branch before submitting this PR?
|
||||
|
||||
Below is a template to help you describe your PR.
|
||||
-->
|
||||
|
||||
-- Please delete this line and all lines above this line before submitting the PR. Thanks! --
|
||||
<!--
|
||||
Provide a summary of your change. Feel free to use paragraphs or a bulleted list, for example:
|
||||
|
||||
**Summary of the changes included in this PR**
|
||||
- Improves performance by 10,000%.
|
||||
- Fixes all bugs.
|
||||
- Boils the oceans.
|
||||
|
||||
**Issue(s) addressed by this PR**
|
||||
- Fixes #
|
||||
-->
|
||||
|
||||
**Things to consider while reviewing this PR**
|
||||
<!--
|
||||
Does this PR fix one or more reported issues?
|
||||
If yes, use `Fixes #<issue number>` to automatically close the fixed issue(s) when the PR is merged.
|
||||
-->
|
||||
|
||||
**Suggested release note for the first release which contains this PR**
|
||||
**Release note**:
|
||||
|
||||
<!--
|
||||
Does this PR introduce a user-facing change?
|
||||
|
||||
If no, just write "NONE" in the release-note block below.
|
||||
If yes, a release note is required. Enter your extended release note in the block below.
|
||||
-->
|
||||
```release-note
|
||||
|
||||
```
|
||||
release-note here
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user