From 6693ff3229a996ebe8de0a6b51950d74bf5f9135 Mon Sep 17 00:00:00 2001
From: Paul Romano <paul.k.romano@gmail.com>
Date: Mon, 12 Jun 2023 09:35:12 -0500
Subject: [PATCH] Add issue and pull request templates (#2560)

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 29 +++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml         |  5 ++++
 .github/ISSUE_TEMPLATE/documentation.md   | 10 ++++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 19 +++++++++++++++
 .github/pull_request_template.md          | 24 +++++++++++++++++++
 5 files changed, 87 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/documentation.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..99ba77a6f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Report a bug that is preventing proper operation
+title: ''
+labels: Bugs
+assignees: ''
+
+---
+
+<!--
+If you are a user of OpenMC and are running into trouble with the code or are
+seeking general user support, we highly recommend posting on the OpenMC
+discourse forum first. GitHub issues should be used specifically for bug reports
+and feature requests.
+
+https://openmc.discourse.group/
+
+-->
+
+## Bug Description
+<!--A clear and concise description of the problem (Note: A missing feature is not a bug).-->
+
+
+## Steps to Reproduce
+<!--Steps to reproduce the behavior (input file, or modifications to an existing input file, etc.)-->
+
+
+## Environment
+<!--Operating system, OpenMC version, how OpenMC was installed, nuclear data being used, etc.-->
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..40e40338b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Troubleshooting and User Support
+    url: https://openmc.discourse.group/
+    about: For user support and troubleshooting, please use our Discourse forum
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
new file mode 100644
index 000000000..04ecb8cf9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -0,0 +1,10 @@
+---
+name: Documentation improvement
+about: Found something incomplete or incorrect in our documentation?
+title: ''
+labels: Documentation
+assignees: ''
+
+---
+
+<!--Describe the issue with the documentation and include a URL to the corresponding page-->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..ddf49b894
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest a new feature or enhancement to existing capabilities
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Description
+<!--What is the feature or enhancement?-->
+
+
+## Alternatives
+<!--If alternative solutions have been considered, describe them here and the reasoning for the chosen solution --->
+
+
+## Compatibility
+<!--Will the enhancement change existing APIs or add something new?-->
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..030914812
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,24 @@
+<!--
+If you are a first-time contributor to OpenMC, please have a look at our
+contributing guidelines:
+https://github.com/openmc-dev/openmc/blob/develop/CONTRIBUTING.md
+-->
+
+# Description
+
+Please include a summary of the change and which issue is fixed if applicable. Please also include relevant motivation and context.
+
+Fixes # (issue)
+
+# Checklist
+
+- [ ] I have performed a self-review of my own code
+- [ ] I have run [clang-format](https://docs.openmc.org/en/latest/devguide/styleguide.html#automatic-formatting) on any C++ source files (if applicable)
+- [ ] I have followed the [style guidelines](https://docs.openmc.org/en/latest/devguide/styleguide.html#python) for Python source files (if applicable)
+- [ ] I have made corresponding changes to the documentation (if applicable)
+- [ ] I have added tests that prove my fix is effective or that my feature works (if applicable)
+<!--
+While tests will automatically be checked by CI, it is good practice to
+ensure that they pass locally first. See instructions here:
+https://docs.openmc.org/en/latest/devguide/tests.html
+-->