Add PR templates for atmospheric_physics #115
Conversation
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>`) | ||
|
|
||
| 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?
There was a problem hiding this comment.
not exactly sure what to do here. there aren't any tests that are required to be run for atmospheric_physics PRs.
i guess i could do List and CAM or CAM-SIMA test failures? but that seems like a duplication of effort. I could also just remove this line.
@nusbaume @jimmielin thoughts?
There was a problem hiding this comment.
I think when I went through my ZM PR, Jesse said this would be the automated github tests. So, perhaps this just need to be List any github automated test failures
There was a problem hiding this comment.
hmmm. i guess so? i feel like the odds of us force pushing a PR that has failing automated tests seems small though.
| 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):
There was a problem hiding this comment.
I would suggest the Summary should be amended to say (include Issue title and the keyword ['closes', 'fixes', 'resolves'] and issue number)
There was a problem hiding this comment.
I've used @cacraigucar 's modified language. And changed from "summary" to "description". does that work? I feel like we're deep in semantics...
There was a problem hiding this comment.
@mwaxmonsky - Yes, the PR title will be already displayed. The PR will be closing one or more issues, and those need to be listed in the PR template, which is what this section is asking for. Sometimes the PR title doesn't cover all the issues which are being brought in in one PR.
| Originator(s): | ||
|
|
||
| Summary (include the keyword ['closes', 'fixes', 'resolves'] and issue number): | ||
|
|
There was a problem hiding this comment.
I would suggest the Summary should be amended to say (include Issue title and the keyword ['closes', 'fixes', 'resolves'] and issue number)
|
|
||
| Summary (include the keyword ['closes', 'fixes', 'resolves'] and issue number): | ||
|
|
||
| Describe any changes made to the namelist: |
There was a problem hiding this comment.
Perhaps change this to List any namelist files that were added
| 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.
I think when I went through my ZM PR, Jesse said this would be the automated github tests. So, perhaps this just need to be List any github automated test failures
.github/pull_request_template.md
Outdated
| @@ -0,0 +1,4 @@ | |||
| Please go the the `Preview` tab and select the appropriate PR template: | |||
|
|
|||
| * [Develop branch](?expand=1&template=develop-template.md) | |||
There was a problem hiding this comment.
A nit picky detail - the branch is development
| Originator(s): | ||
|
|
||
| Summary (include the keyword ['closes', 'fixes', 'resolves'] and issue number): | ||
|
|
There was a problem hiding this comment.
@mwaxmonsky - Yes, the PR title will be already displayed. The PR will be closing one or more issues, and those need to be listed in the PR template, which is what this section is asking for. Sometimes the PR title doesn't cover all the issues which are being brought in in one PR.
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!