-
Notifications
You must be signed in to change notification settings - Fork 785
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a pull request template. Modeled after CRI-O (Thanks @saschagrunert!) and Dockers. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
- Loading branch information
1 parent
5b69f70
commit 94550b8
Showing
1 changed file
with
66 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| <!-- | ||
| Thanks for sending a pull request! | ||
| Please make sure you've read and understood our contributing guidelines | ||
| (https://github.com/containers/buildah/blob/master/CONTRIBUTING.md) as well as ensuring | ||
| that all your commits are signed with `git commit -s`. | ||
| --> | ||
|
|
||
| #### What type of PR is this? | ||
|
|
||
| <!-- | ||
| Please label this pull request according to what type of issue you are | ||
| addressing, especially if this is a release targeted pull request. | ||
| Uncomment only one `/kind <>` line, hit enter to put that in a new line, and | ||
| remove leading whitespace from that line: | ||
| --> | ||
|
|
||
| > /kind api-change | ||
| > /kind bug | ||
| > /kind cleanup | ||
| > /kind deprecation | ||
| > /kind design | ||
| > /kind documentation | ||
| > /kind failing-test | ||
| > /kind feature | ||
| > /kind flake | ||
| > /kind other | ||
| #### What this PR does / why we need it: | ||
|
|
||
| #### How to verify it | ||
|
|
||
| #### Which issue(s) this PR fixes: | ||
|
|
||
| <!-- | ||
| Automatically closes linked issue when PR is merged. | ||
| Uncomment the following comment block and include the issue | ||
| number or None on one line. | ||
| Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`, or `None`. | ||
| --> | ||
|
|
||
| <!-- | ||
| Fixes # | ||
| or | ||
| None | ||
| --> | ||
|
|
||
| #### Special notes for your reviewer: | ||
|
|
||
| #### 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. If the PR | ||
| requires additional action from users switching to the new release, include the | ||
| string "action required". | ||
| For more information on release notes please follow the kubernetes model: | ||
| https://git.k8s.io/community/contributors/guide/release-notes.md | ||
| --> | ||
|
|
||
| ```release-note | ||
| ``` | ||
|
|
94550b8There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI, the "Uncomment only one /kind line" part of the tempalte is confusing in 2 ways:
First, they're outside the
-->comment block, and>is not a comment in markdown 😕Something like "remove leading
>from only one line" could be clearer.Second, if one forgets to surrond it with empty lines:
markdown's "lazy continuation" rule still parses it as part of the block quote!
Sampling a few recent PRs at random, a few suffer from this e.g. #2401, #2361.
Consider switching to "remove all /kind lines" except one" approach (as done in eg. #2380).
94550b8There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well I see this is straight from kubernetes' template, will discuss on kubernetes/kubernetes#71685