diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 69fc8e64d..b8848c5e2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,17 @@ ## Closes issue -Replace `ISSUE_NUMBER` with the issue number that your pull request fixes. Then GitHub will link and automatically close the related issue. +Replace `ISSUE_NUMBER` with the issue number that your pull request addresses. This links the pull request to the related issue. Choose the appropriate form. + +If you completely resolve the issue, then use `"Closes"`. +GitHub will automatically close the related issue when the PR gets merged. - [ ] Closes #ISSUE_NUMBER +If you resolve only a part of the issue, then use `"See"`. +This form keeps the issue open for future work. + +- [ ] See #ISSUE_NUMBER + ## Description Write a description of the fixes or improvements. diff --git a/news/1394.internal b/news/1394.internal new file mode 100644 index 000000000..4e1c5a226 --- /dev/null +++ b/news/1394.internal @@ -0,0 +1 @@ +Support keeping a linked issue open in the pull request template when the pull request fixes only a part of the original issue. @stevepiercy