Use HTML comments in github templates#1538
Conversation
|
@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:
|
HTML comments are 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 |
|
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? |
|
was merged with #1535. |
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
Anticipated changes to regression tests:
Subcomponents involved:
Combined with PR's (If Applicable):
Commit Queue Checklist:
Linked PR's and Issues:
Closes /issues/1537
Testing Day Checklist:
Testing Log (for CM's):
Testing not required.