tools/commit_form.txt

   1 The first line should be a single-line "purpose" for this change
   2
   3 TYPE: choose one of [bug fix, enhancement, new feature, feature removed, no impact, text only]
   4
   5 KEYWORDS: 5 to 10 words related to commit, separated by commas
   6
   7 SOURCE: Either "developer's name (affiliation)" .XOR. "internal" for a WRF Dev committee member
   8
   9 DESCRIPTION OF CHANGES:
  10 Problem:
  11 Generally or specifically, what was wrong and needed to be addressed?
  12
  13 Solution:
  14 What was down algorithmically and in the source code to address the problem?
  15
  16 ISSUE: For use when this PR closes an issue.
  17 Fixes #123
  18
  19 LIST OF MODIFIED FILES: list of changed files (use `git diff --name-status master` to get formatted list)
  20
  21 TESTS CONDUCTED:
  22 1. Do mods fix problem? How can that be demonstrated, and was that test conducted?
  23 2. Are the Jenkins tests all passing?
  24
  25 RELEASE NOTE: Include a stand-alone message suitable for the inclusion in the minor and annual releases. A publication citation is appropriate.
  26
  27 ------------------------------------------------------------------
  28
  29 For github pull requests, the beginning single-line "purpose" should be entered in the title line
  30 See https://github.com/wrf-model/WRF/wiki/Changes-to-the-WRF-code-from-start-to-finish for examples
  31
  32 Description of commit types:
  33 - "bug fix"
  34   Fixing a demonstrably incorrect portion of code
  35
  36 - "enhancement"
  37   Changing an existing portion of the code; though the old code was not unambiguously
  38   wrong, this change presumably improves the code
  39
  40 - "new feature"
  41   Adding a new feature to the code
  42
  43 - "feature removed"
  44   Removing an existing feature of the code
  45
  46 - "no impact"
  47   For display changes such as changing the "version_decl", changing variable names,
  48   improving error messages, changing quoted Registry elements, or otherwise changing what
  49   appears in the log/out/error files but not impacting history/restart output results, timing
  50   performance, or memory footprint
  51
  52 - "text only"
  53   For README and comments, changing quoted Registry elements, white space alignment, or other
  54   changes which have no impact on program output or log files.  Additionally, any change which
  55   does not impact any of the compiled code.