Skip to content
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.

Sign up for GitHub

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 8 commits into from
Feb 13, 2025
Merged

Add PR templates for atmospheric_physics #115

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
deb114e
add PR templates
peverwhee Aug 30, 2024
c63386f
add default template
peverwhee Aug 30, 2024
0ce6e39
Update develop-template.md
peverwhee Sep 4, 2024
18a0ff3
Update main-template.md
peverwhee Sep 4, 2024
ed5fcb9
Update main-template.md
peverwhee Nov 19, 2024
cdd09d2
address review comments
peverwhee Jan 29, 2025
f0e9da0
fix branch name
peverwhee Jan 29, 2025
6325d5f
address review comments
Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/develop-template.md
View file
Open in desktop
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):

Copy link
Collaborator

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?

Copy link
Collaborator

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?

Copy link
Collaborator

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):
image

Copy link
Collaborator

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)

Copy link
Collaborator Author

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...

Copy link
Collaborator

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.

Describe any changes made to the namelist:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps change this to List any namelist files that were added

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!


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>`)

List any test failures:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmmm. i guess so? i feel like the odds of us force pushing a PR that has failing automated tests seems small though.

Copy link
Collaborator

@nusbaume nusbaume Feb 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I think for an atmospheric_physics PR we should only list any automated tests that fail. Right now they are pretty sparse, but will very likely increase in number (hopefully sooner rather than later). So maybe the language can be changed to:

List all automated tests that failed, as well as an explanation for why they weren't fixed.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed!


Is this a science-changing update? New physics package, algorithm change, tuning changes, etc?
6 changes: 6 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/main-template.md
View file
Open in desktop
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:
4 changes: 4 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
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)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A nit picky detail - the branch is development

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!

* [Main branch](?expand=1&template=main-template.md)