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.

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

Update Github issue templates to use issue forms #2288

Open
wants to merge 4 commits into
base: dev/no-diff-to-benchmark
Choose a base branch
from

Conversation

msulprizio
Copy link
Contributor

Name and Institution (Required)

Name: Melissa Sulprizio
Institution: Harvard

Describe the update

Github issue template files are updated to utilize issue forms. This involves using YAML configuration files instead of markdown. This should make issue submissions easier for users and will ensure users provide the required information.

Note that issue forms are not supported for pull requests currently.

Expected changes

This is a zero difference update to model output. It will only impact the look of submitting issues on Github once merged into the main branch.

Related Github Issue(s)

Closes #1831.

Here we have updated the Github issue template files to utilize forms.
This involves using YAML configuration files instead of markdown. This
should make issue submissions easier for users and will ensure users provide
the required information.

Note that issue forms are not supported for pull requests currently. The
pull request form here has been cleaned up slightly.

Addresses feature request #1831.

Signed-off-by: Melissa Sulprizio <mpayer@seas.harvard.edu>
@msulprizio msulprizio added category: Feature Request New feature or request never stale Never label this issue as stale no-diff-to-benchmark This update will not change the results of fullchem benchmark simulations topic: GitHub Related to GitHub labels, templates or actions labels May 10, 2024
@msulprizio msulprizio self-assigned this May 10, 2024
@msulprizio msulprizio marked this pull request as ready for review May 21, 2024 17:07
@msulprizio
Copy link
Contributor Author

A temporary repository has been set up at https://github.com/msulprizio/test_issues_form/issues/new/choose for testing these new forms without merging into main here.

Copy link
Contributor

@yantosca yantosca left a comment

Choose a reason for hiding this comment

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

Thanks @msulprizio. This looks great overall, I've just noted a few minor things.

.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug-report.yml Outdated Show resolved Hide resolved
Signed-off-by: Melissa Sulprizio <mpayer@seas.harvard.edu>
Removed the dropdown for selecting a compiler used and now use a text box
so users can also provide the compiler version.

Signed-off-by: Melissa Sulprizio <mpayer@seas.harvard.edu>
@msulprizio msulprizio requested a review from yantosca May 21, 2024 18:18
Copy link
Contributor

@lizziel lizziel left a comment

Choose a reason for hiding this comment

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

This looks great for GC-Classic issues. I wonder if we should have a drop-down for what simulation, e.g. fullchem, and configuration, e.g. GC-Classic nested, they are using. Sometimes GCHP users create issues on GEOS-Chem repo but there is no place for them to say they are using GCHP.

Copy link
Contributor

@yantosca yantosca left a comment

Choose a reason for hiding this comment

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

Thanks for the updates @msulprizio! Good to merge, pending @lizziel's additional comments

Now require user to specify the configuration (GCClassic, GCHP, etc.),
simulation type (fullchem, carbon, etc.), resolution, and meteorology
used when encountering the bug reported.

Signed-off-by: Melissa Sulprizio <mpayer@seas.harvard.edu>
@msulprizio
Copy link
Contributor Author

I wonder if we should have a drop-down for what simulation, e.g. fullchem, and configuration, e.g. GC-Classic nested, they are using. Sometimes GCHP users create issues on GEOS-Chem repo but there is no place for them to say they are using GCHP.

@lizziel That's a good point! I added additional entries to the form for configuration, simulation type, resolution, and met field.

Screenshot 2024-05-21 at 3 44 41 PM

Let me know if you think anything else should be added/changed!

@yantosca
Copy link
Contributor

@lizziel @msulprizio, this looks great!

@msulprizio msulprizio requested a review from lizziel May 21, 2024 20:23
@lizziel
Copy link
Contributor

lizziel commented May 21, 2024

Looks good! A few more comments:

  • If using GCHP then users should also provide MPI library and version
  • If we include CESM and WRF-GC then we should also include GEOS
  • I'm hesitant to start down the path of asking for libraries and config files for GEOS-Chem in external models. GCHP run issues should be in the GCHP github, and GEOS-Chem in GEOS issues go to the GMAO github, and CESM issues go to the CESM user forum. I don't think we give WRF-GC help either. I wonder if we should add a note pointing people to those resources?

@lizziel
Copy link
Contributor

lizziel commented May 21, 2024

Thinking more about this, I can see GMAO developers making an issue (although right now they just ping me on their own github issues) and NCAR developers too if they have a question or something breaks. But I still wonder if we should list other resources somewhere such as GCHP GitHub for GCHP issues, or explain GEOS-Chem repo issues are for all GC-Classic issues plus science codebase issues if run in GCHP or other models.

@yantosca yantosca changed the base branch from dev/no-diff-to-benchmark to dev/14.4.0 May 22, 2024 15:41
@yantosca yantosca changed the base branch from dev/14.4.0 to dev/no-diff-to-benchmark May 22, 2024 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: Feature Request New feature or request never stale Never label this issue as stale no-diff-to-benchmark This update will not change the results of fullchem benchmark simulations topic: GitHub Related to GitHub labels, templates or actions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE REQUEST] Use yml and incorporate other form elements in issue templates
3 participants