Create pull_request_template.md #330
Conversation
Adding a template for Pull Request
|
@ukmo-ccbunney could you comment/edit it |
| ### Issue(s) addressed | ||
| * Is there an issue associated with this development (bug fix, enhancement, new feature)? | ||
| Please add a reference to a related issue(s) in WW3 repository. | ||
| Link the issues to be closed with this PR, whether in this repository, or in another repository. |
There was a problem hiding this comment.
Maybe give a link to this GitHub page:
https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue
Note that properly "linked issues" (either automatic links, or manual ones using the correct keywords) will be automatically closed when the PR is merged.
There was a problem hiding this comment.
@ukmo-ccbunney Done.
There was a problem hiding this comment.
@aliabdolali I made a few suggestions, which you may or may not want to address. Thanks for adding this!
.github/pull_request_template.md
Outdated
| ### Check list | ||
| * Is your feature branch up to date with the authoritative repository (NOAA/develop)? | ||
| * 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), [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) | ||
| * @mentions of the person or team responsible for reviewing proposed changes. |
There was a problem hiding this comment.
Maybe this line should be:
Reviewers: @mentions of suggested reviewers of the proposed changes
.github/pull_request_template.md
Outdated
| * How were these changes tested? | ||
| * Are the changes covered by regression tests? (If not, why? Do new tests need to be added?) | ||
| * If a new feature was added, was a new regression test added? | ||
| * Have regression tests and unit tests been run? |
There was a problem hiding this comment.
We don't have unit tests yet, so I'd just ask if the regression tests have been run
.github/pull_request_template.md
Outdated
| * Are the changes covered by regression tests? (If not, why? Do new tests need to be added?) | ||
| * If a new feature was added, was a new regression test added? | ||
| * Have regression tests and unit tests been run? | ||
| * What compilers / HPCs was it tested with? |
There was a problem hiding this comment.
This seems to be a repeat of the next line.
.github/pull_request_template.md
Outdated
| * Have regression tests and unit tests been run? | ||
| * What compilers / HPCs was it tested with? | ||
| * Which compiler you used to run the regression tests in the PR? | ||
| * please provide the summary output of matrix.comp (_matrix.Diff.out_, _matrixCompFull.out_ and _matrixCompSummary.out_): |
There was a problem hiding this comment.
Capitalize P. Should we just ask at the end to:
Please indicate the expected changes in the outputs (excluding the known list of non-identical tests)
Linking to the list of non-identical tests?
Adding a template for Pull Request