Explicitly list references in the pull request template #1798
Conversation
This file contains 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
simonzhaoms
requested review from
miguelgfierro,
gramhagen,
anargyri,
loomlike and
wutaomsft
as code owners
miguelgfierro
deleted the
simonz/2022-0720-1050/add-reference-to-pull-request-template
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
It may be helpful to explicitly mention the references in pull requests. Thus reviewers can have a better understanding of the PRs, and are confident that authors have done researches about the issues.
The 'References' section can be taken as a complement to the 'Related Issues' in the pull request template when there are no issues associated with the PRs.
The idea comes from the PR #1797 (comment), where I added references in the comment to explain why the amendment to exclude paths in a GitHub workflow works.
Related Issues
Checklist:
staging branchand not tomain branch.