From d10242995ac89d706863392bffe70d8d4225b35f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?M=C3=A1rcio=20Barbosa?=
 <52362496+barbmarcio@users.noreply.github.com>
Date: Mon, 5 Aug 2024 12:50:25 +0100
Subject: [PATCH] feat: add issue templates
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This PR adds Issue Templates.

You can see what it would look like
[here](https://github.com/barbmarcio/rando/issues/new/choose)

---------

Co-authored-by: Johan Bergström <johan@topsort.com>
---
 .github/ISSUE_TEMPLATE/1-bug-report.yml      | 53 ++++++++++++++++++++
 .github/ISSUE_TEMPLATE/2-feature-request.yml | 43 ++++++++++++++++
 .github/ISSUE_TEMPLATE/3-docs-problem.yml    | 21 ++++++++
 3 files changed, 117 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/1-bug-report.yml
 create mode 100644 .github/ISSUE_TEMPLATE/2-feature-request.yml
 create mode 100644 .github/ISSUE_TEMPLATE/3-docs-problem.yml

diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml
new file mode 100644
index 0000000..cc125e6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml
@@ -0,0 +1,53 @@
+name: 🪲 Bug report
+description: Create a report to help us improve
+labels: [bug]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for reporting an issue.
+
+        Please complete the below form to help us look into the issue.  
+        
+        Note: if you are looking for help, create a [discussion](https://github.com/Topsort/topsort.js/discussions) instead.
+  - type: textarea
+    id: description
+    attributes:
+      label: Bug Description
+      description: A clear and concise description of what the bug is.
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to reproduce the behavior, preferably a sample code snippet.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected behavior
+      description: What is the expected behavior? Why is that the expected behavior?
+    validations:
+      required: true
+  - type: input
+    id: sdk-version
+    attributes:
+      label: SDK Version
+      description: Provide the SDK version (e.g., 0.2.0).
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        **Environment (please complete the following information):**
+        - OS: [e.g. iOS, Android, Windows]
+        - Browser [e.g. Chrome, Safari] (or runtime) [e.g. Node.js, Deno, Bun]
+        - Version [e.g. 22]
+  - type: input
+    id: environment
+    attributes:
+      label: Environment
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml
new file mode 100644
index 0000000..5cbf65e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2-feature-request.yml
@@ -0,0 +1,43 @@
+name: 💡 Feature request
+description: Suggest an idea for this project
+labels: [enhancement]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Is your feature request related to a problem? Please describe.**
+        
+  - type: textarea
+    id: problem-description
+    attributes:
+      label: Problem Description
+      description: Describe the problem that your feature request is related to.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        **Describe the solution you'd like**
+        A clear and concise description of what you want to happen.
+  - type: textarea
+    id: solution-description
+    attributes:
+      label: Solution Description
+      description: Describe the solution you would like.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        **Describe alternatives you've considered**
+        A clear and concise description of any alternative solutions or features you've considered.
+  - type: textarea
+    id: alternatives-description
+    attributes:
+      label: Alternatives Considered
+      description: Describe any alternative solutions or features you've considered.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/3-docs-problem.yml b/.github/ISSUE_TEMPLATE/3-docs-problem.yml
new file mode 100644
index 0000000..7e85c91
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/3-docs-problem.yml
@@ -0,0 +1,21 @@
+name: 📝 Documentation issue
+description: Report an issue related to the documentation
+labels: [documentation]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Describe the issue**
+        A clear and concise description of what the documentation issue is.
+  - type: textarea
+    id: issue-description
+    attributes:
+      label: Issue Description
+      description: Describe the documentation issue.
+    validations:
+      required: true
+  - type: input
+    id: issue-location
+    attributes:
+      label: Issue Location
+      description: Provide the URL or section of the documentation where the issue is found.