-
Notifications
You must be signed in to change notification settings - Fork 170
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
Conversation
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 <[email protected]>
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 |
There was a problem hiding this 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.
Signed-off-by: Melissa Sulprizio <[email protected]>
9a5a2f7
to
e4a555f
Compare
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 <[email protected]>
There was a problem hiding this 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.
There was a problem hiding this 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 <[email protected]>
@lizziel That's a good point! I added additional entries to the form for configuration, simulation type, resolution, and met field. Let me know if you think anything else should be added/changed! |
@lizziel @msulprizio, this looks great! |
Looks good! A few more comments:
|
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. |
Remove CESM and WRF-GC from model configuration option and instead add a note instructing users to contact the specific model's support if running into issues with GEOS-Chem in an external model. Signed-off-by: Melissa Sulprizio <[email protected]>
8959c19
to
4a2c423
Compare
@lizziel I removed the options related to external models from the configuration question and added a note for users to check with the external model's support. |
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)