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.

Sign up for GitHub

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

Jump to bottom

[FEATURE REQUEST] Use yml and incorporate other form elements in issue templates #1831

Open
lizziel opened this issue Jun 14, 2023 · 1 comment · May be fixed by #2288
Open

[FEATURE REQUEST] Use yml and incorporate other form elements in issue templates #1831

lizziel opened this issue Jun 14, 2023 · 1 comment · May be fixed by #2288
Labels
category: Feature Request New feature or request topic: GitHub Related to GitHub labels, templates or actions

Comments

@lizziel
Copy link
Contributor

lizziel commented Jun 14, 2023 •
edited

Name and Institution (Required)

Name: Lizzie Lundgren
Institution: Harvard University

New GEOS-Chem feature or discussion

This is non-urgent nice-to-have feature request for a rainy day.

Sometimes a submitted GitHub issue does not have all of the information that GCST requests, or has a format that is difficult to read. We could encourage better issue reports by using drop-down menus and comment boxes in our issue templates. To facilitate this we could also change from using markdown to yaml format in the template files.

An example of another model that does this is CAM in CESM. See here for what the user sees and here for the template code.

GitHub documentation on this topic::
Syntax for issue forms
Syntax for GitHub's form schema
@lizziel lizziel added the category: Feature Request New feature or request label Jun 14, 2023
@msulprizio
Copy link
Contributor

Adding to that, it would be nice to remove the checklists asking users to verify that they've reviewed the docs and instead include an autoresponse pointing users to the documentation if they are reporting a bug. See: https://www.techielass.com/automate-your-replies-to-github-issues/.

@yantosca yantosca added the topic: GitHub Related to GitHub labels, templates or actions label Mar 29, 2024
msulprizio added a commit that referenced this issue May 10, 2024
@msulprizio
Update Github issue templates to use issue forms
6931c74 
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 linked a pull request May 10, 2024 that will close this issue
Open
@msulprizio msulprizio linked a pull request May 10, 2024 that will close this issue
Update Github issue templates to use issue forms #2288
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
category: Feature Request New feature or request topic: GitHub Related to GitHub labels, templates or actions
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update Github issue templates to use issue forms geoschem/geos-chem
3 participants
@lizziel @msulprizio @yantosca