|
1 | 1 | # Pull Request Summary
|
2 |
| -(Instructions: this, and all subsequent sections of text should be removed and filled in as appropriate.) |
3 |
| -Please describe the PR summary |
| 2 | +<!-- A short overview of the PR --> |
4 | 3 |
|
5 | 4 | ## Description
|
| 5 | +<!-- |
6 | 6 | Provide a detailed description of what this PR does.
|
7 | 7 | What bug does it fix, or what feature does it add?
|
8 | 8 | Is a change of answers expected from this PR?
|
9 | 9 |
|
10 |
| -### Issue(s) addressed |
11 |
| -* Is there an issue associated with this development (bug fix, enhancement, new feature)? |
12 |
| -Please add a reference to a related issue(s) in WW3 repository (Follow [link](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)). |
13 |
| -Link the issues to be closed with this PR, whether in this repository, or in another repository. |
14 |
| -(Remember, issues should always be created before starting work on a PR branch!). |
15 |
| -Note that properly "linked issues" (either automatic links, or manual ones using the correct keywords) will be automatically closed when the PR is merged. |
| 10 | +Please also include the following information: |
| 11 | +* Add any suggestions for a reviewer |
| 12 | +* Mention any labels that should be added: _bug_, _documentation_, _enhancement_, _new feature_ |
| 13 | +* Are answer changes expected from this PR? Please describe the changes and the reason why in addition to which of the following labels would apply: _mod_def change_, _out_grd change_, _out_pnt change_, _restart file change_, _Regression test_ |
| 14 | +--> |
16 | 15 |
|
| 16 | +### Issue(s) addressed |
| 17 | +<!-- |
| 18 | +* Please list any issues associated with this PR, including those the PR will fix/close. For example: |
17 | 19 | - fixes #<issue_number>
|
18 | 20 | - fixes noaa-emc/ww3/issues/<issue_number>
|
| 21 | +--> |
| 22 | + |
| 23 | +### Commit Message |
| 24 | +<!-- |
| 25 | +Please provide a short summary of this PR, which will be used during _Squash and Merge_ and will be shown as a git log message. Be sure to add any co-authors here. |
| 26 | +--> |
19 | 27 |
|
20 | 28 | ### Check list
|
21 |
| -* Is your feature branch up to date with the authoritative repository (NOAA/develop)? |
22 |
| -* Make sure you have checked the [checklist for a developer submitting to develop](https://github.com/NOAA-EMC/WW3/wiki/Code-Management#checklist-for-a-developer-submitting-to-develop) and [updating version number](https://github.com/NOAA-EMC/WW3/wiki/Code-Management#checklist-for-updating-version-number) |
23 |
| -* Please list appropriate labels code managers should add for this PR: |
24 |
| - _bug_, _documentation_, _enhancement_, _new feature_, .. |
25 |
| - |
26 |
| -* Reviewers: @mentions of suggested reviewers of the proposed changes |
27 | 29 |
|
28 |
| -### Commit Message |
29 |
| -* Please provide a short summary of this PR, which will be used during _Squash and Merge_ and will be shown as git log message |
| 30 | +<!-- After creating the PR you can check each of the items below that have been completed --> |
30 | 31 |
|
| 32 | +- [ ] Branch is up to date with the authoritative repository (NOAA-EMC) develop branch. |
| 33 | +- [ ] Checked the [checklist for a developer submitting to develop](https://github.com/NOAA-EMC/WW3/wiki/Code-Management#checklist-for-a-developer-submitting-to-develop). |
| 34 | +- [ ] If a version number update is required, checked the [updating version number](https://github.com/NOAA-EMC/WW3/wiki/Code-Management#checklist-for-updating-version-number) checklist. |
| 35 | +- [ ] If a new feature was added, a regression test for testing the new feature is added. |
| 36 | + |
31 | 37 | ### Testing
|
| 38 | + |
32 | 39 | * How were these changes tested?
|
33 | 40 | * Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)
|
34 |
| -* If a new feature was added, was a new regression test added? |
35 |
| -* Have regression tests been run? |
36 |
| -* Which compiler / HPC you used to run the regression tests in the PR? |
| 41 | +* Have the matrix regression tests been run (if yes, please note HPC and compiler)? |
37 | 42 | * Please provide the summary output of matrix.comp (_matrix.Diff.txt_, _matrixCompFull.txt_ and _matrixCompSummary.txt_):
|
38 |
| -Please indicate the expected changes in the outputs ([excluding the known list of non-identical tests](https://github.com/NOAA-EMC/WW3/wiki/How-to-use-matrix.comp-to-compare-regtests-with-master#4-look-at-results)). |
39 |
| -* Please list which labels code managers should add to indicate code changes: |
40 |
| -_mod_def change_, _out_grd change_, _out_pnt change_, _restart file change_, _Regression test_, ... |
| 43 | +* Please indicate the expected changes in the regression test output ([Note the known list of non-identical tests](https://github.com/NOAA-EMC/WW3/wiki/How-to-use-matrix.comp-to-compare-regtests-with-master#4-look-at-results)). |
| 44 | +* Please provide the summary output of matrix.comp (_matrix.Diff.txt_, _matrixCompFull.txt_ and _matrixCompSummary.txt_): |
41 | 45 |
|
0 commit comments