Update Github issue templates

The existing issue and pull request templates have been removed and replaced with templates that have been greatly simplified. The new templates: 1. Point users to the support and contribution guidelines, documentation, and debug pages first. 2. Include a section for users to identify themselves and their institution since this is not always obvious from their Github accounts. 3. Remove automatic tags and bracketed titles. These should be assigned by the user or by the GCST upon initial review of new issues. The CONTRIBUTING.md and SUPPORT.md files have also been updated to include links to one another. Signed-off-by: Melissa Sulprizio <mpayer@seas.harvard.edu>
geoschem · Feb 28, 2023 · 97b8de4 · 97b8de4
1 parent 7fd2210
commit 97b8de4
Show file tree

Hide file tree

Showing 9 changed files with 76 additions and 144 deletions.
diff --git a/.github/ISSUE_TEMPLATE/new-feature-or-discussion.md b/.github/ISSUE_TEMPLATE/new-feature-or-discussion.md
@@ -0,0 +1,17 @@
+---
+name: Request a new GCClassic feature or start a discussion
+about: Use this template for topics relevant to the GCClassic superproject. For GEOS-Chem and HEMCO see the respective repositories.
+---
+
+### Name and Institution (Required)
+
+Name:
+Institution:
+
+### Confirm you have reviewed the following documentation
+
+- [ ] [Contributing guidelines](https://geos-chem.readthedocs.io/en/stable/reference/CONTRIBUTING.html)
+
+### New GCClassic feature or discussion
+
+Please provide a clear and concise overview of the discussion topic or new feature requested.
diff --git a/.github/ISSUE_TEMPLATE/question-issue.md b/.github/ISSUE_TEMPLATE/question-issue.md
@@ -0,0 +1,21 @@
+---
+name: Ask a question about or report an issue with GCClassic
+about: Use this template for topics relevant to the GCClassic superproject. For GEOS-Chem or HEMCO see the respective repositories on Github.
+---
+
+### Name and Institution (Required)
+
+Name:
+Institution:
+
+### Confirm you have reviewed the following documentation
+
+- [ ] [Support guidelines](https://geos-chem.readthedocs.io/en/stable/reference/SUPPORT.html)
+- [ ] [User manuals](https://geos-chem.readthedocs.io/en/stable/geos-chem-shared-docs/supplemental-guides/related-docs.html)
+- [ ] [Debugging GEOS-Chem and HEMCO errors](https://geos-chem.readthedocs.io/en/stable/geos-chem-shared-docs/supplemental-guides/debug-guide.html)
+- [ ] [Current and past Github issues](https://github.com/geoschem/GCClassic/issues)
+
+### Description of your issue or question
+
+Please provide as much detail as possible. Always include the GCClassic version number and any relevant configuration and log files.
+
diff --git a/.github/ISSUE_TEMPLATE/report-a-gcclassic-bug.md b/.github/ISSUE_TEMPLATE/report-a-gcclassic-bug.md
diff --git a/.github/ISSUE_TEMPLATE/request-a-new-feature.md b/.github/ISSUE_TEMPLATE/request-a-new-feature.md
diff --git a/.github/PULL_REQUEST_TEMPLATE/create-a-gcclassic-pull-request.md b/.github/PULL_REQUEST_TEMPLATE/create-a-gcclassic-pull-request.md
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull-request.md b/.github/PULL_REQUEST_TEMPLATE/pull-request.md
@@ -0,0 +1,30 @@
+---
+name: Submit updates to the GCClassic superproject with a pull request
+labels: 'never stale'
+
+---
+
+### Name and Institution (Required)
+
+Name:
+Institution:
+
+### Confirm you have reviewed the following documentation
+
+- [ ] [Contributing guidelines](https://geos-chem.readthedocs.io/en/stable/reference/CONTRIBUTING.html)
+
+### Describe the update
+
+Please provide a clear and concise overview of the update.
+
+### Expected changes
+
+Please provide details on how this update will impact model output and include plots or tables as needed.
+
+### Reference(s)
+
+If this is a science update, please provide a literature citation.
+
+### Related Github Issue(s)
+
+Please link to the corresponding Github issue here. If fixing a bug, there should be an issue describing it with steps to reproduce.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ This file documents all notable changes to the GEOS-Chem Classic wrapper reposit
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased 14.1.1]
+### Changed
+  - Simplified Github issue and pull request templates
+
 ## [14.1.0] - 2023-02-01
 ### Added
   - Added SANITIZE CMake option

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -72,7 +72,7 @@ Also follow these additional steps to ensure that your data can be read by GCHP:
 We accept feature requests through issues on GitHub. To request a new feature, **[open a new issue](https://github.com/geoschem/geos-chem/issues/new/choose)** and select the feature request template. Please include all the information that migth be relevant, including the motivation for the feature.
 
 ## How can I report a bug?
-Please see "Support Guidelines".
+Please see **[Support Guidelines](https://geos-chem.readthedocs.io/en/stable/reference/SUPPORT.html)**.
 
 ## Where can I ask for help?
-Please see "Support Guidelines".
+Please see **[Support Guidelines](https://geos-chem.readthedocs.io/en/stable/reference/SUPPORT.html)**
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -20,7 +20,7 @@ Even though we can assist in several ways, we cannot possibly do everything.  We
 If you have a science question rather than a technical question, you should contact the relevant [GEOS-Chem Working Group(s)](https://geos-chem.seas.harvard.edu/geos-working-groups) directly. But if you do not know whom to ask, you may open a new issue (See "Where can I ask for help" above) and we will be happy to direct your question to the appropriate person(s).
 
 ## How to submit changes
-Please see "Contributing Guidelines".
+Please see **[Contributing Guidelines](https://geos-chem.readthedocs.io/en/stable/reference/CONTRIBUTING.html)**.
 
 ## How to request an enhancement
-Please see "Contributing Guidelines".
+Please see **[Contributing Guidelines](https://geos-chem.readthedocs.io/en/stable/reference/CONTRIBUTING.html)**.