From 3ff4da71cd35692d507bbd36e34994bcbbf4d365 Mon Sep 17 00:00:00 2001
From: DerMoehre <94791958+DerMoehre@users.noreply.github.com>
Date: Sun, 2 Oct 2022 22:34:25 +0200
Subject: [PATCH] Add bug reporting form and README update

Completes a subtask of #70.
Squashed commit of PR #72 by DerMoehre
---
 .github/ISSUE_TEMPLATE/bug_report.yml | 40 +++++++++++++++++++++++++++
 .gitignore                            |  1 +
 README.md                             |  4 +++
 3 files changed, 45 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..75cc1e3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,40 @@
+name: Bug Report
+description: The software does something unwanted or unusual
+title: "[BUG]: "
+labels: ["bug"]
+
+body:
+  - type: markdown
+    attributes: 
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: checkboxes
+    id: new-bug
+    attributes:
+      label: Did you search for similar bugs?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+      - label: I have searched the existing issues
+        required: false
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: What happened?
+      description: Tell us what bug you encountered
+    validations:
+      required: true
+  - type: textarea
+    id: bug-behaviour
+    attributes:
+      label: Expectations?
+      description: Tell us what should have happened
+    validations:
+      required: true
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps To Reproduce
+      description: Can you describe your steps, when you encountered the bug?
+      placeholder: Please write the steps in a list form
+    validations:
+      required: false
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 7d04f9b..5a4b3a8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,6 +7,7 @@
 *.wav
 build/*
 docs/_build
+*.code-workspace
 *.swp
 *.orig
 env
diff --git a/README.md b/README.md
index c5d85a4..a9ba76c 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,10 @@ You can find user support for installing and using the FAVE toolkits at the [FAV
 ## Contributing to FAVE
 For the most part, we'll be utilizing the fork-and-pull paradigm (see [Using Pull Requests](https://help.github.com/articles/using-pull-requests)). Please send pull requests to the `dev` branch.
 
+You can fill in a bug report at the [issue tab](https://github.com/JoFrhwld/FAVE/issues)
+
+There may be a delay between when a bug is reported and when a bug is resolved. Developers prioritize bugs based on difficulty, importance, and other factors, so bug reports are usually not handled in the order they are received. 
+
 ## Attribution
 [![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.22281.svg)](http://dx.doi.org/10.5281/zenodo.22281)
 As of v1.1.3 onwards, releases from this repository will have a DOI associated with them through Zenodo. The DOI for the current release is [10.5281/zenodo.22281](http://dx.doi.org/10.5281/zenodo.22281). We would recommend the citation: