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.

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

Update Github issue templates to use issue forms #276

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 115 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -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
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 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
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 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
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://hemco.readthedocs.io/en/stable/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.
7 changes: 5 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 YAML definition files

## [3.8.1] - 2024-04-02
### Changed
Expand Down