From 6931c74a9295494847e3ba8f8ccaa0fa91aefe30 Mon Sep 17 00:00:00 2001 From: Melissa Sulprizio Date: Fri, 10 May 2024 10:53:00 -0400 Subject: [PATCH 1/5] 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 | 88 +++++++++++++++++++ .../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, 164 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 000000000..90ddfcb8b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,88 @@ +name: Bug or Issue Report +description: Report a bug or issue with GEOS-Chem +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.rc, and HEMCO_Config.rc here. You may need to rename files to end in .txt first. + validations: + required: false + - type: input + id: version + attributes: + label: What GEOS-Chem version were you using? + placeholder: ex. 14.4.0 + validations: + required: true + - type: dropdown + id: machine + attributes: + label: What environment were you running GEOS-Chem on? + multiple: true + options: + - Local cluster + - AWS + - Personal computer + - Other (please explain below) + validations: + required: true + - type: dropdown + id: compiler + attributes: + label: What compiler were you using? + multiple: true + options: + - Intel + - GNU + - PGI + - Other (please specify below) + 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 \ No newline at end of file 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 b50374bed..000000000 --- a/.github/ISSUE_TEMPLATE/new-feature-or-discussion.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Request a new GEOS-Chem feature or start a discussion -about: Use this form to request a new GEOS-Chem feature or start a discussion ---- - -### 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 GEOS-Chem 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 000000000..ccd5a90d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-feature.yml @@ -0,0 +1,50 @@ +name: Feature Request +description: Request a new GEOS-Chem 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, I., D. J. Jacob, R. M. Yantosca, J. A. Logan, B. Field, A. M. Fiore, Q. Li, H. Liu, L. J. Mickley, and M. Schultz, 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question-discussion.yml b/.github/ISSUE_TEMPLATE/question-discussion.yml new file mode 100644 index 000000000..d94d155d1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question-discussion.yml @@ -0,0 +1,23 @@ +name: Question or Discussion +description: Ask a question about GEOS-Chem 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question-issue.md b/.github/ISSUE_TEMPLATE/question-issue.md deleted file mode 100644 index 35350726a..000000000 --- a/.github/ISSUE_TEMPLATE/question-issue.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Ask a question about GEOS-Chem or report an issue with GEOS-Chem -about: Use this form to ask a question about GEOS-Chem or to report an issue ---- - -### 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/geos-chem/issues) - -### Description of your issue or question - -Please provide as much detail as possible. Always include the GEOS-Chem version number and any relevant configuration and log files. - diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f33b11a80..0875ee15a 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 1f31c29b3..d1b05cb6f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -44,6 +44,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - Changed input data paths in `run/GEOS` directory to match location change on NASA discover cluster - Use new mask files at 0.1 x 0.1 degree resoluiton for CH4/tagCH4/carbon simulations to avoid I/O bottlenecks - Update config files for CH4/carbon simulations to avoid reading the same variable multiple times +- Converted Github issue templates to issue forms using YAML definition files ### Fixed - Corrected the formula for 1st order heterogeneous chemical loss on stratospheric aerosol for NO2, NO3, and VOC. From e4a555f0d86ea247dfb19883ed04850304a322b4 Mon Sep 17 00:00:00 2001 From: Melissa Sulprizio Date: Tue, 21 May 2024 13:07:15 -0400 Subject: [PATCH 2/5] Fix typo and formatting in issue template forms Signed-off-by: Melissa Sulprizio --- .github/ISSUE_TEMPLATE/bug-report.yml | 7 +++---- .github/ISSUE_TEMPLATE/new-feature.yml | 2 +- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 90ddfcb8b..198090241 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -32,8 +32,8 @@ body: - 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.rc, and HEMCO_Config.rc here. You may need to rename files to end in .txt first. + 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 @@ -61,9 +61,8 @@ body: label: What compiler were you using? multiple: true options: - - Intel - GNU - - PGI + - Intel - Other (please specify below) validations: required: true diff --git a/.github/ISSUE_TEMPLATE/new-feature.yml b/.github/ISSUE_TEMPLATE/new-feature.yml index ccd5a90d2..64f08b9e4 100644 --- a/.github/ISSUE_TEMPLATE/new-feature.yml +++ b/.github/ISSUE_TEMPLATE/new-feature.yml @@ -26,7 +26,7 @@ body: attributes: label: Reference(s) description: If this is a science update, please provide a literature citation. - placeholder: e.g. Bey, I., D. J. Jacob, R. M. Yantosca, J. A. Logan, B. Field, A. M. Fiore, Q. Li, H. Liu, L. J. Mickley, and M. Schultz, Global modeling of tropospheric chemistry with assimilated meteorology: Model description and evaluation, J. Geophys. Res., 106, 23,073-23,096, 2001. + 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 From 9a12d4819a4235dce35a0b7267eaac0e33f2727a Mon Sep 17 00:00:00 2001 From: Melissa Sulprizio Date: Tue, 21 May 2024 14:15:44 -0400 Subject: [PATCH 3/5] Update bug report issue form to require user to specify compiler version 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 --- .github/ISSUE_TEMPLATE/bug-report.yml | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 198090241..db55024c6 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -40,7 +40,7 @@ body: id: version attributes: label: What GEOS-Chem version were you using? - placeholder: ex. 14.4.0 + placeholder: e.g. 14.4.0 validations: required: true - type: dropdown @@ -55,15 +55,11 @@ body: - Other (please explain below) validations: required: true - - type: dropdown - id: compiler + - type: input + id: compiler-version attributes: - label: What compiler were you using? - multiple: true - options: - - GNU - - Intel - - Other (please specify below) + 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 From 6306946c519cedfc11e4946a489b30ead0e7ce0e Mon Sep 17 00:00:00 2001 From: Melissa Sulprizio Date: Tue, 21 May 2024 15:46:40 -0400 Subject: [PATCH 4/5] Add entries for additional simulation information to the bug report form 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 --- .github/ISSUE_TEMPLATE/bug-report.yml | 54 +++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index db55024c6..1c3186d8c 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -74,6 +74,60 @@ body: - "No" validations: required: true + - type: dropdown + id: configuration + attributes: + label: In what configuration were you running GEOS-Chem? + multiple: false + options: + - GCClassic + - GCHP + - CESM + - WRF-GC + - Other (please explain in additional information section below) + validations: + required: true + - type: dropdown + id: simulation + attributes: + label: What simulation were you running? + description: If using full chemistry, specify extra options like benchmark, complexSOA, etc. in the additional information section below + multiple: false + options: + - Full chemistry + - Aerosol + - Carbon + - Hg + - POPs + - TagO3 + - TransportTracers + - Trace metals + - CH4 + - CO2 + - TagCO + validations: + required: true + - type: input + id: resolution + attributes: + label: As what resolution were you running GEOS-Chem? + description: If running a nested grid simulation, please also specify the region. + placeholder: "e.g. 4x5, 2x2.5, 0.25x0.3125 NA, c48, c180" + 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: From 4a2c4237a165b9ce30d601d81c2459c705184145 Mon Sep 17 00:00:00 2001 From: Melissa Sulprizio Date: Wed, 29 May 2024 08:53:22 -0400 Subject: [PATCH 5/5] Modify model configuration section in bug report issues form 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 --- .github/ISSUE_TEMPLATE/bug-report.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 1c3186d8c..b82973516 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -78,12 +78,11 @@ body: id: configuration attributes: label: In what configuration were you running GEOS-Chem? + description: If you are experiencing issues with GEOS-Chem in an external model, please contact that model's support. This repository is for tracking issues related to the GEOS-Chem science code base. multiple: false options: - GCClassic - GCHP - - CESM - - WRF-GC - Other (please explain in additional information section below) validations: required: true @@ -134,4 +133,4 @@ body: label: Additional information description: Please provide any additional information here that you think might be relevant. validations: - required: false \ No newline at end of file + required: false