Skip to content

Use HTML comments in github templates#1538

Closed
BrianCurtis-NOAA wants to merge 5 commits into
ufs-community:developfrom
BrianCurtis-NOAA:comment_templates
Closed

Use HTML comments in github templates#1538
BrianCurtis-NOAA wants to merge 5 commits into
ufs-community:developfrom
BrianCurtis-NOAA:comment_templates

Conversation

@BrianCurtis-NOAA
Copy link
Copy Markdown
Collaborator

@BrianCurtis-NOAA BrianCurtis-NOAA commented Dec 16, 2022

Description

This PR brings in template changes to reflect better all that is involved in our pull request tasks and help us process them quicker. It also brings in HTML comments to make the PR/Issues/Bugs appear cleaner on the outside but providing ample information to the submitter.

Top of commit queue on: TBD

Input data additions/changes

  • No changes are expected to input data.
  • There will be new input data.
  • Input data will be updated.

Anticipated changes to regression tests:

  • No changes are expected to any regression test.
  • Changes are expected to the following tests:

Subcomponents involved:

  • AQM
  • CDEPS
  • CICE
  • CMEPS
  • CMakeModules
  • FV3
  • GOCART
  • HYCOM
  • MOM6
  • NOAHMP
  • WW3
  • stochastic_physics
  • none

Combined with PR's (If Applicable):

Commit Queue Checklist:

  • Link PR's from all sub-components involved
  • Confirm reviews completed in sub-component PR's
  • Add all appropriate labels to this PR.
  • Run full RT suite on either Hera/Cheyenne with both Intel/GNU compilers
  • Add list of any failed regression tests to "Anticipated changes to regression tests" section.

Linked PR's and Issues:

Closes /issues/1537

Testing Day Checklist:

  • This PR is up-to-date with the top of all sub-component repositories except for those sub-components which are the subject of this PR.
  • Move new/updated input data on RDHPCS Hera and propagate input data changes to all supported systems.

Testing Log (for CM's):

Testing not required.

@BrianCurtis-NOAA BrianCurtis-NOAA added No Baseline Change No Baseline Change Ready for Commit Queue The PR is ready for the Commit Queue. All checkboxes in PR template have been checked. labels Dec 16, 2022
@BrianCurtis-NOAA BrianCurtis-NOAA marked this pull request as ready for review December 16, 2022 21:14
@DeniseWorthen
Copy link
Copy Markdown
Collaborator

@BrianCurtis-NOAA I don't understand what "HTML comments" are. Also, where did the information regarding any input data update go?

For the "anticipated changes", I still think we need to be very explicit about what we expect. It is not until the bottom that you say that we expect a list of any changed tests. I think as it is now, we'll get a lot of single word answers in the top section (yes, no). Can we have something like:

Anticipated changes to regression tests:

  • No changes are expected to any regression test.
  • Changes are expected to the following tests:

@BrianCurtis-NOAA
Copy link
Copy Markdown
Collaborator Author

@BrianCurtis-NOAA I don't understand what "HTML comments" are. Also, where did the information regarding any input data update go?

HTML comments are <!-- (text here) --> This tells the browser to not show that content similar to how ! in FORTRAN tells the compiler to ignore that line.

Using HTML comments in the templates allows us to provide guidance for filling out the template without needing to be deleted or having all that information clogging the important information we want to see.

The information regarding the input data was held in comments, but your idea has inspired me to make a similar change for input data.

@DeniseWorthen Make sure to checkout the raw code, so you can see the HTML comments: https://raw.githubusercontent.com/BrianCurtis-NOAA/ufs-weather-model/comment_templates/.github/pull_request_template.md

@DeniseWorthen
Copy link
Copy Markdown
Collaborator

I see. Thanks. Thanks for adding the input data sections. Do you think the difference between "adding" input data and "changing" input data is clear?

@jkbk2004
Copy link
Copy Markdown
Collaborator

was merged with #1535.

@jkbk2004 jkbk2004 closed this Dec 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

No Baseline Change No Baseline Change Ready for Commit Queue The PR is ready for the Commit Queue. All checkboxes in PR template have been checked.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Upgrade templates to use HTML comments

3 participants