Add PR templates for atmospheric_physics #115
Conversation
peverwhee
requested review from
jimmielin,
cacraigucar,
mattldawson,
nusbaume,
boulderdaze and
mwaxmonsky
There was a problem hiding this comment.
It is important to keep in mind that the guts of CAM-SIMA will reside in this repository and when we update a scheme, this repository's "ChangeLog" is probably the most important (more so than what will reside in CAM-SIMA). I've tried to look at this PR template with that in mind.
|
|
||
| List all existing files that have been modified, and describe the changes: | ||
| (Helpful git command: `git diff --name-status development...<your_branch_name>`) | ||
|
|
There was a problem hiding this comment.
Add additional bullet like List how this code was validated with the new/modified features - i.e. How does the developer know that it is doing the proper thing?
| List all existing files that have been modified, and describe the changes: | ||
| (Helpful git command: `git diff --name-status development...<your_branch_name>`) | ||
|
|
||
| List any test failures: |
There was a problem hiding this comment.
Perhaps specify what tests we expect to be run: List any regression test failures on xxx/yyy (where xxx/yyy is each computer/compiler). I think it is just one combo right now, but perhaps that might change?
Are there other tests we currently expect developers to run?
| Originator(s): | ||
|
|
||
| Summary (include the keyword ['closes', 'fixes', 'resolves'] and issue number): | ||
|
|
There was a problem hiding this comment.
Perhaps add a bullet like: Purpose of PR (new scheme, modification to existing scheme, bug fix to scheme, etc.). This might be unnecessary if the PR title covers this, but if it doesn't, perhaps this information would be useful?
There was a problem hiding this comment.
For this section (summary and purpose), would it make sense to follow a layout similar to a few other open sourced projects (ex. dotnet/aspnetcore#55968), where we have Summary, Description and then a section for fixes/resolutions, followed by the other sections below?
There was a problem hiding this comment.
Also, I think we can remove the summary line in general because the top line in the commit message will be the PR title (as seen from my last PR into the develop branch):
|
|
||
| List any test failures: | ||
|
|
||
| Is this a science-changing update? New physics package, algorithm change, tuning changes, etc? |
There was a problem hiding this comment.
I would suggest the bullet should be something like: Is this an answer changing PR? If so, is it a new physics package, algorithm change, tuning changes, etc?
Github is not exactly spectacular at handling multiple templates. From what I can tell, our options are:
Create Pull RequestEither way, I'd appreciate any feedback!