-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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 geoschem/geos-chem#1831. Signed-off-by: Melissa Sulprizio <[email protected]>
- Loading branch information
1 parent
ceeb4c9
commit 2ffe838
Showing
7 changed files
with
152 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters