From 6f351d0924e4d2fa61aae8964ab11abe093e7cda Mon Sep 17 00:00:00 2001
From: KamenDimitrov97 <kamen.dimitrov@flaxandteal.co.uk>
Date: Tue, 13 Aug 2024 14:14:55 +0300
Subject: [PATCH] docs: Added issue templates for easier and more comprehensive
 issue generation.

---
 .../workflows/ISSUE_TEMPLATE/bug_report.md    | 53 +++++++++++++++++++
 .../ISSUE_TEMPLATE/feature_request.md         | 23 ++++++++
 .../improve_existing_functionality.md         | 52 ++++++++++++++++++
 3 files changed, 128 insertions(+)
 create mode 100644 .github/workflows/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/workflows/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/workflows/ISSUE_TEMPLATE/improve_existing_functionality.md

diff --git a/.github/workflows/ISSUE_TEMPLATE/bug_report.md b/.github/workflows/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..ac70338
--- /dev/null
+++ b/.github/workflows/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,53 @@
+---
+name: "🐛 Bug report"
+about: "Report a bug to help us improve"
+title: "🐛 Title"
+labels: ["bug"]
+assignees: ['']
+---
+### Issue Summary
+
+Briefly describe the issue you are experiencing.
+
+### Steps to Reproduce
+
+Provide a clear and concise set of steps to reproduce the issue. Include code snippets or screenshots if they can help in understanding the problem.
+
+1. Step 1
+2. Step 2
+3. ...
+
+### Expected Behavior
+
+Describe what you expected to happen.
+
+### Actual Behavior
+
+Describe what actually happened.
+
+### Environment
+
+- **Operating System:**
+- **Project Version/Commit:**
+- **Additional context (if any):**
+
+### Possible Solution
+
+(Optional) If you have suggestions on how to fix the issue or implement the feature, please let us know or open an improvement proposal.
+
+### Screenshots
+
+(Optional) If you can, add screenshots to help explain your problem.
+
+### Additional Information
+
+Add any other context or information about the issue here.
+
+#### Checklist
+-  [] I have reviewed existing issues and confirmed that this issue has not been logged before.
+-  [] I have provided minimal example of expected vs actual behavior.
+
+---
+
+**Note:** Please make sure to check if there is already an existing issue similar to yours before submitting a new one. If you find an existing issue,
+you can comment  on it to provide additional information or to show that you are experiencing the same problem.
diff --git a/.github/workflows/ISSUE_TEMPLATE/feature_request.md b/.github/workflows/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..ac5c76f
--- /dev/null
+++ b/.github/workflows/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,23 @@
+---
+name: "✨ Feature request"
+about: "Suggest an idea for this project"
+title: "✨ Title"
+labels: ["feat request"]
+assignees: ['']
+---
+
+### Is your feature request related to a problem?
+A clear and concise description of what the problem is.
+If an bug report exists please link it here.
+
+### Describe the behaviour you'd like
+A clear and concise description of what you want to happen.
+
+### Describe alternative software applications you've considered using
+A clear and concise description of any alternative software applications you've considered.
+
+### Describe workarounds you've implemented while the feature request is being reviewed
+If you can, add code snippets of any workaround you've implemented
+
+### Additional context
+Add any other context or screenshots about the feature request here.
diff --git a/.github/workflows/ISSUE_TEMPLATE/improve_existing_functionality.md b/.github/workflows/ISSUE_TEMPLATE/improve_existing_functionality.md
new file mode 100644
index 0000000..6432302
--- /dev/null
+++ b/.github/workflows/ISSUE_TEMPLATE/improve_existing_functionality.md
@@ -0,0 +1,52 @@
+---
+name: "🛠 Improvement proposal"
+about: "Improve an existing feature"
+title: "🛠 Title"
+labels: ["enhancement"]
+assignees: ['']
+---
+### Improvement Proposal
+
+Describe the improvement you would like to see. Be clear and concise.
+
+#### Current Functionality
+
+Describe the existing functionality or feature that you think needs improvement.
+
+#### Proposed Enhancement
+
+Detail your proposed enhancement or improvement.
+
+#### Motivation
+
+Explain why this improvement is necessary or beneficial.
+
+#### Expected Benefits
+
+Outline the benefits or outcomes you expect from implementing this improvement.
+
+#### Implementation Plan (Optional)
+
+If you have ideas or suggestions on how this improvement could be implemented, outline them here.
+
+#### Alternative Approaches or Workaround used before (Optional)
+
+If applicable, describe any alternative approaches you considered or explored.
+
+#### Screenshots or Additional Information
+
+If applicable.
+
+#### Checklist
+
+-  [] I have reviewed existing issues and confirmed that this improvement has not been proposed before.
+-  [] I have considered the impact of this improvement on other parts of the project.
+-  [] I am willing to contribute to the implementation of this improvement if the proposal is accepted.
+
+#### Related Issues
+
+If your proposal is related to an existing issue or PR, mention it here.
+
+#### Additional Notes
+
+Add any additional notes or context about your proposal.