Skip to content

Add "Fixes: number" to PR template for auto-closing issues - #2557

Merged
DaanHoogland merged 1 commit into
apache:4.11from
khos2ow:enhance-pr-template
Apr 12, 2018
Merged

Add "Fixes: number" to PR template for auto-closing issues#2557
DaanHoogland merged 1 commit into
apache:4.11from
khos2ow:enhance-pr-template

Conversation

@khos2ow

@khos2ow khos2ow commented Apr 9, 2018

Copy link
Copy Markdown
Contributor

Description

Added GitHub issue section to PULL_REQUEST_TEMPLATE.md with Fixes: #<issue_id> format. With this addition, the referenced issue will automatically be closed when PR gets merged.

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)

Screenshots (if appropriate):

How Has This Been Tested?

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
    Testing
  • I have added tests to cover my changes.
  • All relevant new and existing integration tests have passed.
  • A full integration testsuite with all test that can run on my environment has passed.

Comment thread PULL_REQUEST_TEMPLATE.md

<!-- 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 -->

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be part of the description? The pull request form is already very long.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>)

@rafaelweingartner rafaelweingartner Apr 11, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true! Although the correct syntax would be Fixes #..., Fixes #..., .... The keyword needs to be specified before number everytime (reference).

@khos2ow
khos2ow force-pushed the enhance-pr-template branch from 99c8fc0 to b7d7ba0 Compare April 11, 2018 19:05
@DaanHoogland
DaanHoogland merged commit 5d05da2 into apache:4.11 Apr 12, 2018
@yadvr yadvr added this to the 4.11.1.0 milestone Apr 12, 2018
@khos2ow
khos2ow deleted the enhance-pr-template branch April 12, 2018 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants