Updated PR submission guidelines with issue references - #147
Open
bluedotblue wants to merge 1 commit into
Open
Conversation
Emphasize including issue references in PR descriptions for closure. closes pyOpenSci#142
InessaPawson
requested changes
Aug 29, 2026
InessaPawson
left a comment
InessaPawson
left a comment
Contributor
There was a problem hiding this comment.
Thanks for this, @bluedotblue! Apologies for the slow response on our end. This is a good catch: linking a PR to an issue is a very useful step to know when submitting a PR.
It's worth noting that addresses isn't one of GitHub's closing keywords. It only creates a cross-reference between a PR and an issue. Since this is teaching material, let's make that distinction clear.
Also, please include all keywords that trigger auto-close:
close/closes/closed
fix/fixes/fixed
resolve/resolves/resolved
|
|
||
| Add a descriptive title and write a brief description of your changes. Pull request titles should be concise and descriptive of the content in the pull request. When you have added your | ||
| title and description, click on “Create Pull Request” one more time to submit the PR. | ||
| Add a descriptive title and write a brief description of your changes. Pull request titles should be concise and descriptive of the content in the pull request. Within the PR description, it is important to include `closes #` issue number or `addresses #` issue number so once the maintainer merges your PR, Github will close the issue number. |
Contributor
There was a problem hiding this comment.
Suggested change
| Add a descriptive title and write a brief description of your changes. Pull request titles should be concise and descriptive of the content in the pull request. Within the PR description, it is important to include `closes #` issue number or `addresses #` issue number so once the maintainer merges your PR, Github will close the issue number. | |
| Add a descriptive title and write a brief description of your changes. Pull request titles should be concise and descriptive of the content in the pull request. Within the PR description, it is important to include `closes #IssueNumber` or `addresses #IssueNumber` so once the maintainer merges your PR, GitHub will close the issue automatically. |
Contributor
|
@allcontributors please add @bluedotblue for doc |
Contributor
|
I've put up a pull request to add @bluedotblue! 🎉 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Emphasize including issue references in PR descriptions for closure. closes #142