From 606c7d7af18c8bcf33c22c7bd26d299b1f976524 Mon Sep 17 00:00:00 2001
From: Eric Vantillard <eric.vantillard@evaxion.fr>
Date: Thu, 16 Mar 2023 02:59:45 +0100
Subject: [PATCH] chore: add issue templates

---
 .github/ISSUE_TEMPLATE/bug_report.md          | 38 +++++++++++++++++++
 .../ISSUE_TEMPLATE/documentation_request.md   | 27 +++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md     | 17 +++++++++
 3 files changed, 82 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/documentation_request.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..d3a80d7e3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/documentation_request.md b/.github/ISSUE_TEMPLATE/documentation_request.md
new file mode 100644
index 000000000..7209a03e1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation_request.md
@@ -0,0 +1,27 @@
+---
+name: Documentation request
+about: Identify an area for improvement in documentation
+
+---
+
+**What is the URL of the documentation?**
+
+- **Example:** https://github.com/evantill/docker-cheerpj/blob/main/README.md#example-of-using-cheerpj-on-your-computer
+
+    - *Note:*  This URL includes the web page and the section of the documentation.
+
+**What can be improved?**
+
+A clear and concise description of what can be improved.
+Examples:
+
+- "I don't understand where the ${XYZ} variable is set."
+- "There seems to be a step missing between 'X' and 'Z'.   I don't know how to get to 'Z'."
+- "When I run `command sub-command ...`  I get the following error:"
+- "I don't know what is meant by 'gerble barb gazoink` in the instructions".
+
+**Additional context**
+
+Add any other context or screenshots to help describe the documentation improvement.
+If you think the documentation improvement is operating system specific,
+please indicate which operating system is being used.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..066b2d920
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**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.