Skip to content

PR template#571

Merged
scrasmussen merged 1 commit intoNCAR:mainfrom
scrasmussen:pr-template
Mar 28, 2025
Merged

PR template#571
scrasmussen merged 1 commit intoNCAR:mainfrom
scrasmussen:pr-template

Conversation

@scrasmussen
Copy link
Copy Markdown
Member

SOURCE: Soren Rasmussen, NSF NCAR

DESCRIPTION OF CHANGES: Pull request template.

  • Simple template to help facilitate well documented PRs
  • Special additions are made after the comment section to help bring in ufs-community:ufs/dev PRs.

NOTES: If there are more or less items in the template that people would like, please let me know.

@grantfirl
Copy link
Copy Markdown
Collaborator

@scrasmussen I think that it would be a good idea to have something like the "Changes" section of the UW PR template: (see, e.g. ufs-community/ufs-weather-model#2655). In particular, this would be a good spot to put in things like expected RT result changes, input data changes, and changes to the software stack needed (pretty darn rare, though).

@scrasmussen
Copy link
Copy Markdown
Member Author

@scrasmussen I think that it would be a good idea to have something like the "Changes" section of the UW PR template: (see, e.g. ufs-community/ufs-weather-model#2655). In particular, this would be a good spot to put in things like expected RT result changes, input data changes, and changes to the software stack needed (pretty darn rare, though).

Thanks for the input! I'll add those things

@scrasmussen scrasmussen marked this pull request as draft March 20, 2025 21:41
@dustinswales
Copy link
Copy Markdown
Member

@scrasmussen Thanks for creating this template.
Should we put a line for associated CCPP SCM and CCPP framework PRs? Maybe above the optional ufs/dev section?

@hertneky
Copy link
Copy Markdown
Collaborator

@scrasmussen This is shaping up nice with everyones suggestions.
Should we include a line about 'including sufficient documentation updates', as necessary?

@scrasmussen
Copy link
Copy Markdown
Member Author

Thanks everyone for your feedback! Moving PR from draft to ready-for-review.

Changes address:

  • @grantfirl added REGRESSION TEST CHANGES section
  • @dustinswales added associated physics and framework section
  • @hertneky added "Update documentation if needed " note

@scrasmussen scrasmussen marked this pull request as ready for review March 25, 2025 16:43
@scrasmussen scrasmussen merged commit 245fa51 into NCAR:main Mar 28, 2025
17 checks passed
@scrasmussen scrasmussen deleted the pr-template branch March 28, 2025 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants