From 2209d1584498096bd97007d87dd475873ccee44e Mon Sep 17 00:00:00 2001
From: Axel Huebl <axel.huebl@plasma.ninja>
Date: Mon, 16 Sep 2024 16:42:31 -0700
Subject: [PATCH] Create Issue Templates

Create issue templates for:
- bugs
- installation issues
- feature requests
- blank
---
 .github/ISSUE_TEMPLATE/bug_report.md         | 34 ++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml            |  1 +
 .github/ISSUE_TEMPLATE/feature_request.md    | 20 +++++++++++
 .github/ISSUE_TEMPLATE/installation-issue.md | 37 ++++++++++++++++++++
 4 files changed, 92 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/ISSUE_TEMPLATE/installation-issue.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000000..3483d0f104b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us reproduce your problem.
+title: ''
+labels: [bug]
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Please share your WarpX inputs files or PICMI Python files here.
+You can drag-and-drop files into this form or zip up larger collections of files, e.g., including analysis scripts to reproduce your problem.
+
+Please minimize your inputs/scripts to be concise and focused on your issue.
+For instance, make the simulation scripts very small and fast to run, whenever possible.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Software Environment**
+- version of WarpX: [YY.MM]
+- installed WarpX via: [conda-forge, spack, pip, brew, from source, module system, ...]
+- operating system: [name and version]
+- machine: [Are you running on a public cluster? It's likely we compute on it as well!]
+- name and version of Python implementation: [e.g. CPython 3.12]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000000..0086358db1e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: true
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000000..c17d3c0dfb2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: [enhancement]
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/installation-issue.md b/.github/ISSUE_TEMPLATE/installation-issue.md
new file mode 100644
index 00000000000..1e26089fdd2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/installation-issue.md
@@ -0,0 +1,37 @@
+---
+name: Installation Issue
+about: Trouble installing WarpX? Let us help you.
+title: ''
+labels: [install, question]
+assignees: ''
+
+---
+
+**Where are you trying to install and run WarpX?**
+A clear and concise description of where you like to run.
+
+**Software Environment**
+- version of WarpX: [e.g., latest or 24.09]
+- operating system: [name and version]
+- machine: [Are you running on a public cluster? It's likely we compute on it as well!]
+
+**What have you tried so far?**
+- installing WarpX via: [conda-forge, spack, pip, brew, from source, module system, ...]
+
+**Installation from Source**
+Are you installing form source? If so, please provide:
+- the output of `cmake --fresh -S . -B build`
+- the output of `cmake --build build`
+
+Let us also know more about your software environment in that case:
+- version of CMake: [e.g. 3.24.0]
+- name and version of your C++ compiler: [e.g., GNU 11.3 with NVCC 12.0.76]
+- name and version of Python implementation: [e.g. CPython 3.12]
+- version of ADIOS2: [e.g. 2.10.0]
+- version of FFTW: [e.g. 3.3.10]
+- version of HDF5: [e.g. 1.14.0]
+- name and version of MPI: [e.g. OpenMPI 4.1.1]
+- name of other relevant dependency names and version: [e.g. NumPy 2.0, Ascent 0.8.0, etc.]
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.