From f4f5ccc7e97d77e7054a409d0f2458262bffe975 Mon Sep 17 00:00:00 2001 From: Melissa Sulprizio Date: Wed, 29 May 2024 09:52:42 -0400 Subject: [PATCH] Update Github issue templates to use issue forms 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 https://github.com/geoschem/geos-chem/issues/1831. Signed-off-by: Melissa Sulprizio --- .github/ISSUE_TEMPLATE/bug-report.yml | 83 +++++++++++++++++++ .../new-feature-or-discussion.md | 17 ---- .github/ISSUE_TEMPLATE/new-feature.yml | 50 +++++++++++ .../ISSUE_TEMPLATE/question-discussion.yml | 23 +++++ .github/ISSUE_TEMPLATE/question-issue.md | 21 ----- .github/PULL_REQUEST_TEMPLATE.md | 8 +- CHANGELOG.md | 1 + 7 files changed, 159 insertions(+), 44 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/new-feature-or-discussion.md create mode 100644 .github/ISSUE_TEMPLATE/new-feature.yml create mode 100644 .github/ISSUE_TEMPLATE/question-discussion.yml delete mode 100644 .github/ISSUE_TEMPLATE/question-issue.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..7940c0c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,83 @@ +name: Bug or Issue Report +description: Report a bug or issue with GCClassic +title: "Put a one-line description here" +labels: ["category: Bug"] +body: + - type: input + id: name + attributes: + label: Your name + validations: + required: true + - type: input + id: affiliation + attributes: + label: Your affiliation + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: What happened? What did you expect to happen? + placeholder: Describe your issue + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: What are the steps to reproduce the bug? + placeholder: Explain what you did + validations: + required: true + - type: textarea + id: log-files + attributes: + label: Please attach any relevant configuration and log files. + description: Drag and drop files like the GEOS-Chem log file, geoschem_config.yml, HEMCO_Config.rc, HISTORY.rc, and build_info/summarize_build here. You may need to rename files to end in .txt first. + validations: + required: false + - type: input + id: version + attributes: + label: What GCClassic version were you using? + placeholder: e.g. 14.4.0 + validations: + required: true + - type: dropdown + id: machine + attributes: + label: What environment were you running GCClassic on? + multiple: true + options: + - Local cluster + - AWS + - Personal computer + - Other (please explain below) + validations: + required: true + - type: input + id: compiler-version + attributes: + label: What compiler and version were you using? + placeholder: e.g. gcc 10.2.0, ifort 19.0.5.281 + validations: + required: true + - type: dropdown + id: implemenation + attributes: + label: Will you be addressing this bug yourself? + description: If Yes, please also assign this issue to yourself (if possible) + multiple: false + options: + - "Yes" + - "Yes, but I will need some help" + - "No" + validations: + required: true + - type: textarea + id: additional-info + attributes: + label: Additional information + description: Please provide any additional information here that you think might be relevant. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/new-feature-or-discussion.md b/.github/ISSUE_TEMPLATE/new-feature-or-discussion.md deleted file mode 100644 index 0cae85e..0000000 --- a/.github/ISSUE_TEMPLATE/new-feature-or-discussion.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Request a new GCClassic feature or start a discussion -about: Use this template for topics relevant to the GCClassic superproject. For GEOS-Chem and HEMCO see the respective repositories. ---- - -### Name and Institution (Required) - -Name: -Institution: - -### Confirm you have reviewed the following documentation - -- [ ] [Contributing guidelines](https://geos-chem.readthedocs.io/en/stable/help-and-reference/CONTRIBUTING.html) - -### New GCClassic feature or discussion - -Please provide a clear and concise overview of the discussion topic or new feature requested. diff --git a/.github/ISSUE_TEMPLATE/new-feature.yml b/.github/ISSUE_TEMPLATE/new-feature.yml new file mode 100644 index 0000000..8e39201 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-feature.yml @@ -0,0 +1,50 @@ +name: Feature Request +description: Request a new GCClassic feature +title: "Put a one-line description here" +labels: ["category: Feature Request"] +body: + - type: input + id: name + attributes: + label: Your name + validations: + required: true + - type: input + id: affiliation + attributes: + label: Your affiliation + validations: + required: true + - type: textarea + id: feature-description + attributes: + label: Provide a clear and concise overview of the new feature requested. + validations: + required: true + - type: textarea + id: reference + attributes: + label: Reference(s) + description: If this is a science update, please provide a literature citation. + placeholder: "e.g. Bey et al., Global modeling of tropospheric chemistry with assimilated meteorology: Model description and evaluation, J. Geophys. Res., 106, 23,073-23,096, 2001." + validations: + required: false + - type: dropdown + id: implemenation + attributes: + label: Will you be implementing this feature yourself? + description: If Yes, please also assign this issue to yourself (if possible) + multiple: false + options: + - "Yes" + - "Yes, but I will need some help" + - "No" + validations: + required: true + - type: textarea + id: additional-info + attributes: + label: Additional information + description: Please provide any additional information here that you think might be relevant. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/question-discussion.yml b/.github/ISSUE_TEMPLATE/question-discussion.yml new file mode 100644 index 0000000..5467a66 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question-discussion.yml @@ -0,0 +1,23 @@ +name: Question or Discussion +description: Ask a question about GCClassic or start a discussion +title: "Put a one-line description here" +labels: ["category: Question"] +body: + - type: input + id: name + attributes: + label: Your name + validations: + required: true + - type: input + id: affiliation + attributes: + label: Your affiliation + validations: + required: true + - type: textarea + id: description + attributes: + label: Please provide a clear and concise description of your question or discussion topic. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/question-issue.md b/.github/ISSUE_TEMPLATE/question-issue.md deleted file mode 100644 index 085db35..0000000 --- a/.github/ISSUE_TEMPLATE/question-issue.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Ask a question about or report an issue with GCClassic -about: Use this template for topics relevant to the GCClassic superproject. For GEOS-Chem or HEMCO see the respective repositories on Github. ---- - -### Name and Institution (Required) - -Name: -Institution: - -### Confirm you have reviewed the following documentation - -- [ ] [Support guidelines](https://geos-chem.readthedocs.io/en/stable/help-and-reference/SUPPORT.html) -- [ ] [User manuals](https://geos-chem.readthedocs.io/en/stable/geos-chem-shared-docs/supplemental-guides/related-docs.html) -- [ ] [Debugging GEOS-Chem and HEMCO errors](https://geos-chem.readthedocs.io/en/stable/geos-chem-shared-docs/supplemental-guides/debug-guide.html) -- [ ] [Current and past Github issues](https://github.com/geoschem/GCClassic/issues) - -### Description of your issue or question - -Please provide as much detail as possible. Always include the GCClassic version number and any relevant configuration and log files. - diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f33b11a..0875ee1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,10 +3,6 @@ Name: Institution: -### Confirm you have reviewed the following documentation - -- [ ] [Contributing guidelines](https://geos-chem.readthedocs.io/en/stable/help-and-reference/CONTRIBUTING.html) - ### Describe the update Please provide a clear and concise overview of the update. @@ -19,6 +15,6 @@ Please provide details on how this update will impact model output and include p If this is a science update, please provide a literature citation. -### Related Github Issue(s) +### Related Github Issue -Please link to the corresponding Github issue here. If fixing a bug, there should be an issue describing it with steps to reproduce. +Please link to the corresponding Github issue(s) here. If fixing a bug, there should be an issue describing it with steps to reproduce. diff --git a/CHANGELOG.md b/CHANGELOG.md index 6432ac5..973cbed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ### Changed - Updated GEOS-Chem submodule to 14.4.0 - Updated HEMCO submodule to 3.9.0 +- Converted Github issue templates to issue forms using YAML definition files ### Removed - `BPCH_DIAG` configuration option and related ReadTheDocs documentation