Add "Fixes: number" to PR template for auto-closing issues - #2557
Conversation
|
|
||
| <!-- If this PR is to fix an issue on GH, uncomment the section and provide the id of issue --> | ||
| <!-- If "Fixes: #<id> is specified, the issue will automatically be closed when PR gets merged --> | ||
|
|
There was a problem hiding this comment.
This can be part of the description? The pull request form is already very long.
There was a problem hiding this comment.
That's true, it can (and should) even be in the commit description as well. I only added another section since we already have some other sections for different purposes, and make it more unified (in terms of placement of Fixes: #<id>)
There was a problem hiding this comment.
Can I suggest one other thing? What about changing ## GitHub Issue to ## GitHub Issues/PRs
Then, you could use:
<!-- List the PRs and issues that this PR addresses. E.g. "Fixes #.., #.., and so on "-->
<!-- Fixes: # -->
A PR can also be used to close (address) other PRs' topic and issues at the same time.
There was a problem hiding this comment.
That's true! Although the correct syntax would be Fixes #..., Fixes #..., .... The keyword needs to be specified before number everytime (reference).
99c8fc0 to
b7d7ba0
Compare
Description
Added GitHub issue section to
PULL_REQUEST_TEMPLATE.mdwithFixes: #<issue_id>format. With this addition, the referenced issue will automatically be closed when PR gets merged.Types of changes
Screenshots (if appropriate):
How Has This Been Tested?
Checklist:
Testing