From 9684a729ce3cdb14d3383bc2a1bf2a33fe2f5915 Mon Sep 17 00:00:00 2001 From: Melissa Sulprizio Date: Wed, 29 May 2024 08:37:27 -0400 Subject: [PATCH 1/2] 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 | 115 ++++++++++++++++++ .../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 | 7 +- 7 files changed, 195 insertions(+), 46 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 00000000..3ff2ac1d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,115 @@ +name: Bug or Issue Report +description: Report a bug or issue with HEMCO +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 HEMCO log file, HEMCO_Config.rc, HEMCO_Diagn.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 HEMCO version were you using? + placeholder: e.g. 3.9.0 + validations: + required: true + - type: dropdown + id: machine + attributes: + label: What environment were you running HEMCO 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: dropdown + id: configuration + attributes: + label: In what configuration were you running HEMCO? + multiple: false + options: + - Standalone + - GCClassic + - GCHP + - Other (please explain in additional information section below) + validations: + required: true + - type: input + id: resolution + attributes: + label: As what resolution were you running HEMCO? + placeholder: "e.g. 4x5, 2x2.5, 0.5x0.625, 0.25x0.3125" + validations: + required: true + - type: dropdown + id: meteorology + attributes: + label: What meterology fields did you use? + multiple: false + options: + - GEOS-FP + - GEOS-IT + - MERRA-2 + - GCAP 2.0 + - Other (please explain in additional information section below) + 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 933c69de..00000000 --- a/.github/ISSUE_TEMPLATE/new-feature-or-discussion.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Request a new HEMCO feature or start a discussion -about: Use this form to request a new HEMCO feature or start a discussion ---- - -### Name and Institution (Required) - -Name: -Institution: - -### Confirm you have reviewed the following documentation - -- [ ] [Contributing guidelines](https://hemco.readthedocs.io/en/stable/reference/CONTRIBUTING.html) - -### New HEMCO 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 00000000..8526e9c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-feature.yml @@ -0,0 +1,50 @@ +name: Feature Request +description: Request a new HEMCO 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 00000000..0eceae70 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question-discussion.yml @@ -0,0 +1,23 @@ +name: Question or Discussion +description: Ask a question about HEMCO 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 663fdc49..00000000 --- a/.github/ISSUE_TEMPLATE/question-issue.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Ask a question about or report an issue with HEMCO -about: Use this form to ask a question about HEMCO or report a HEMCO issue ---- - -### Name and Institution (Required) - -Name: -Institution: - -### Confirm you have reviewed the following documentation - -- [ ] [Support guidelines](https://hemco.readthedocs.io/en/stable/reference/SUPPORT.html) -- [ ] [User manuals](https://hemco.readthedocs.io/en/stable/geos-chem-shared-docs/supplemental-guides/related-docs.html) -- [ ] [Debugging GEOS-Chem and HEMCO errors](https://hemco.readthedocs.io/en/stable/geos-chem-shared-docs/supplemental-guides/debug-guide.html) -- [ ] [Current and past Github issues](https://github.com/geoschem/HEMCO/issues) - -### Description of your issue or question - -Please provide as much detail as possible. Always include the HEMCO version number and any relevant configuration and log files. - diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3400c00a..0875ee15 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://hemco.readthedocs.io/en/stable/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 e9280e5e..6bce1b2c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,9 +8,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] - TBD ### Added - GitHub Action config file `.github/workflows/stale.yml`, which replaces StaleBot - + ### Removed -- GitHub config files `.github/stale.yml` and `.github/no-response.yml` +- GitHub config files `.github/stale.yml` and `.github/no-response.yml` + +### Changed +- Converted Github issue templates into issue forms using TAML definition files ## [3.8.1] - 2024-04-02 ### Changed From 7ef08fbba97cd9c9b99b6fdccdda6553efb4d7d7 Mon Sep 17 00:00:00 2001 From: Melissa Sulprizio Date: Wed, 29 May 2024 10:34:52 -0400 Subject: [PATCH 2/2] Fix typo in CHANGELOG.md Signed-off-by: Melissa Sulprizio --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6bce1b2c..aaebb471 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - GitHub config files `.github/stale.yml` and `.github/no-response.yml` ### Changed -- Converted Github issue templates into issue forms using TAML definition files +- Converted Github issue templates into issue forms using YAML definition files ## [3.8.1] - 2024-04-02 ### Changed