-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add PR templates for atmospheric_physics #115
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
Originator(s): | ||
|
||
Summary (include the keyword ['closes', 'fixes', 'resolves'] and issue number): | ||
|
||
Describe any changes made to the namelist: | ||
|
||
List all files eliminated and why: | ||
|
||
List all files added and what they do: | ||
|
||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add additional bullet like |
||
List any test failures: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Perhaps specify what tests we expect to be run: Are there other tests we currently expect developers to run? |
||
|
||
Is this a science-changing update? New physics package, algorithm change, tuning changes, etc? | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would suggest the bullet should be something like: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Tag name (The PR title should also include the tag name): | ||
Originator(s): | ||
|
||
List all `develop` PR URLs included in this PR and a short description of each: | ||
|
||
List all test failures: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Please go the the `Preview` tab and select the appropriate PR template: | ||
|
||
* [Develop branch](?expand=1&template=develop-template.md) | ||
* [Main branch](?expand=1&template=main-template.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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):