-
Notifications
You must be signed in to change notification settings - Fork 23
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
deb114e
add PR templates
peverwhee c63386f
add default template
peverwhee 0ce6e39
Update develop-template.md
peverwhee 18a0ff3
Update main-template.md
peverwhee ed5fcb9
Update main-template.md
peverwhee cdd09d2
address review comments
peverwhee f0e9da0
fix branch name
peverwhee 6325d5f
address review comments
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Originator(s): | ||
|
||
Description (include issue title and the keyword ['closes', 'fixes', 'resolves'] and issue number): | ||
|
||
List all namelist files that were added or changed: | ||
|
||
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>`) | ||
peverwhee marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
cacraigucar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
List all automated tests that failed, as well as an explanation for why they weren't fixed: | ||
|
||
Is this an answer-changing PR? If so, is it a new physics package, algorithm change, tuning change, etc? | ||
|
||
If yes to the above question, describe how this code was validated with the new/modified features: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 `development` PR numbers included in this PR and the title of each: | ||
|
||
List all automated tests that failed, as well as an explanation for why they weren't fixed: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: | ||
|
||
* [development branch](?expand=1&template=develop-template.md) | ||
* [main branch](?expand=1&template=main-template.md) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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):

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.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.