Skip to content

Commit

Permalink
Add a github pull request template (wrf-model#256)
Browse files Browse the repository at this point in the history
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 log messages 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!
  • Loading branch information
mkavulich authored May 5, 2017
1 parent 2240ab1 commit bae318b
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Use this template to give a detailed message describing the change you want to make to the code.
If you are unclear on what should be written here, see https://github.com/wrf-model/WRF/wiki/Making-a-good-pull-request-message for more guidance

The title of this pull request should be a brief "purpose" for this change.

--- Delete this line and those above before hitting "Create pull request" ---

TYPE: choose one of [bug fix, enhancement, new feature, feature removed, no impact, text only]

KEYWORDS: approximately 3 to 6 words (more is always better) related to your commit, separated by commas

SOURCE: Either "developer's name (affiliation)" .XOR. "internal" for a WRF Dev committee member

DESCRIPTION OF CHANGES: One or more paragraphs describing problem, solution, and required changes.

LIST OF MODIFIED FILES: list of changed files (use `git diff --name-status master` to get formatted list)

TESTS CONDUCTED: Explicitly state if a WTF and or other tests were run, or are pending. For more complicated changes please be explicit!

0 comments on commit bae318b

Please sign in to comment.