Skip to content

Commit 140eaf4

Browse files
committed
Add issue link info to PR template
While reviewing pull requests I noticed there are a lot of PRs that are addressing open issues, but the PRs are not properly linked. This results in a lot of issues being left open, even after the fix has been merged. This updates the PR template to give a short instruction on adding the expected line in the PR description so that the issue and PR can be linked automatically and closed on merge. Signed-off-by: Sean McGinnis <[email protected]>
1 parent 8595373 commit 140eaf4

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
<!--
2-
32
Hello!
43
5-
Remember to ADD A DESCRIPTION and delete this note before submitting
6-
your pull request. The description should explain what will change,
7-
and why.
8-
94
PLEASE title the FIRST commit appropriately, so that if you squash all
105
your commits into one, the combined commit message makes sense.
116
For overall help on editing and submitting pull requests, visit:
@@ -20,5 +15,24 @@
2015
2116
If you're documenting a feature that will be part of a future release, see
2217
https://kubernetes.io/docs/contribute/new-content/new-features/ for advice.
18+
-->
19+
### Description
2320

21+
<!--
22+
Remember to ADD A DESCRIPTION and delete this note before submitting
23+
your pull request. The description should explain what will change,
24+
and why.
25+
-->
26+
27+
### Issue
28+
29+
<!--
30+
If this pull request resolves an open issue, please link the issue in the PR
31+
description so it will automatically close when the PR is merged.
32+
33+
See the GitHub documentation for more details and other options:
34+
35+
https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
2436
-->
37+
38+
Closes: #

0 commit comments

Comments
 (0)