Merge PR #323 (Update Github issue templates to use issue forms)

This merge brings PR #323 (Update Github issue templates to use issue forms,
by @msulprizio) into the GCPy 1.5.0 development stream.

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

Signed-off-by: Bob Yantosca <[email protected]>

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -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

.github/ISSUE_TEMPLATE/new-feature.yml

@@ -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

.github/ISSUE_TEMPLATE/question-discussion.yml

@@ -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

.github/PULL_REQUEST_TEMPLATE.md

@@ -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.
@@ -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.

CHANGELOG.md

@@ -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`