Add a github pull request template #256
Merged
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
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.
TYPE: text only
KEYWORDS: github, pull request template
SOURCE: internal
DESCRIPTION OF CHANGES: I recently learned that Github supports the capability to store a pull request template message as a hidden file in the source code.
Currently the template for pull request messages (which become the
git logmessages we see after the pull request is moved) is stored in the source code under tools/commit_form.txt. This will still be kept for reference, but now a condensed form of this message (with a link to further information) will automatically appear in the text box when you go to open a new pull request.LIST OF MODIFIED FILES:
A .github/PULL_REQUEST_TEMPLATE
TESTS CONDUCTED: Added this template to my fork and attempted to open a new pull request to the master of my fork, confirmed the expected behavior that the text appeared automatically in the text box!