Skip to content

Commit

Permalink
Merge PR #2288 (Update Github issue templates to use issue forms)
Browse files Browse the repository at this point in the history
This merge brings PR # (Update Github issue templates to use issue forms,
by @msulprizio) into the GEOS-Chem "no-diff-to-benchmark development stream.

This PR uses dropdown menus and boxes to ensure that users provide the
required information in the geoschem/geos-chem issue tracker.

Signed-off-by: Bob Yantosca <[email protected]>
  • Loading branch information
yantosca committed May 29, 2024
2 parents ede27d0 + 4a2c423 commit 03d503f
Show file tree
Hide file tree
Showing 7 changed files with 212 additions and 44 deletions.
136 changes: 136 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
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.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 GEOS-Chem version were you using?
placeholder: e.g. 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: 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 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
- 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:
label: Additional information
description: Please provide any additional information here that you think might be relevant.
validations:
required: false
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/new-feature-or-discussion.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/new-feature.yml
Original file line number Diff line number Diff line change
@@ -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 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
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/question-discussion.yml
Original file line number Diff line number Diff line change
@@ -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
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/question-issue.md

This file was deleted.

8 changes: 2 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 03d503f

Please sign in to comment.