Skip to content

Commit

Permalink
Update Github issue templates to use issue forms
Browse files Browse the repository at this point in the history
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 geoschem/geos-chem#1831.

Signed-off-by: Melissa Sulprizio <[email protected]>
  • Loading branch information
msulprizio committed May 29, 2024
1 parent ceeb4c9 commit 2ffe838
Show file tree
Hide file tree
Showing 7 changed files with 152 additions and 44 deletions.
83 changes: 83 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
name: Bug or Issue Report
description: Report a bug or issue with GCPy
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 here. You may need to rename files to end in .txt first.
validations:
required: false
- type: input
id: version
attributes:
label: What GCPy version were you using?
placeholder: e.g. 1.5.0
validations:
required: true
- type: dropdown
id: machine
attributes:
label: What environment were you running GCPy on?
multiple: true
options:
- Local cluster
- AWS
- Personal computer
- Other (please explain below)
validations:
required: true
- type: input
id: compiler-version
attributes:
label: What python environment were you using?
description: Type 'conda list' to view the list of packages in your python environment. Copy the output here or upload a file.
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
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/new-feature-or-discussion.md

This file was deleted.

42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/new-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature Request
description: Request a new GCPy 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: 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 GCPy 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
20 changes: 0 additions & 20 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://gcpy.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 GCPy output and include pl

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.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- Updated GitHub stalebot config file `stale.yml` with new issue/PR labels that should not go stale
- Updated benchmark driver scripts and config files to print GCClassic & GCHP timing information
- Updated documentation for GCPy 1.5.0 release

- Converted Github issue templates to issue forms using YAML definition files

### Fixed
- CS inquiry functions in `gcpy/cstools.py` now work properly for `xr.Dataset` and `xr.DataArray` objects
- Prevent an import error by using `seaborn-v0_8-darkgrid` in`gcpy/benchmark/modules/benchmark_models_vs_obs.py`
Expand Down

0 comments on commit 2ffe838

Please sign in to comment.