From 4d490237f5ddfca31d25b8271384f1f9915c77c2 Mon Sep 17 00:00:00 2001
From: Chris Sewell <chrisj_sewell@hotmail.com>
Date: Tue, 6 Jun 2023 16:29:00 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20DOCS=20improvement=20(#778)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .github/ISSUE_TEMPLATE/1-bug-report.yml      | 57 ++++++++++++++++++++
 .github/ISSUE_TEMPLATE/2-feature-request.yml | 21 ++++++++
 .github/ISSUE_TEMPLATE/3-documentation.yml   | 17 ++++++
 .github/ISSUE_TEMPLATE/config.yml            |  4 ++
 4 files changed, 99 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-documentation.yml
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml

diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml
new file mode 100644
index 00000000..1ddf6ed9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml
@@ -0,0 +1,57 @@
+name: Bug Report
+description: Create a bug report 🐛
+labels: ['bug']
+body:
+  - type: markdown
+    attributes:
+      value: Thank you for taking the time to file a bug report! Please fill out this form as completely as possible.
+  - type: input
+    attributes:
+      label: What version of `myst-parser` are you using?
+      description: 'For example: 1.0.0'
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: What version dependencies are you using?
+      description: 'e.g. for docutils and sphinx'
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: What operating system are you using?
+      options:
+        - Mac
+        - Windows
+        - Linux
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of the bug.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior, please provide clear and concise steps.
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: Please ensure the steps you've provided reproduce the issue to the best of your ability.
+  - type: markdown
+    attributes:
+      value: Ideally, maintainers should be able to follow the steps provided in order to reproduce the bug.
+  - type: markdown
+    attributes:
+      value: Thank you for helping out the MyST team, these issues are what makes MyST better!!
diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml
new file mode 100644
index 00000000..40eb514b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2-feature-request.yml
@@ -0,0 +1,21 @@
+name: Feature Request
+description: Request a new feature ✨
+labels: ['enhancement']
+body:
+  - type: markdown
+    attributes:
+      value: Thank you for taking the time to submit a feature request! Please fill out this form as completely as possible.
+  - type: textarea
+    attributes:
+      label: Describe the feature you'd like to request
+      description: A clear and concise description of what you want and what your use case is.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+  - type: textarea
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
diff --git a/.github/ISSUE_TEMPLATE/3-documentation.yml b/.github/ISSUE_TEMPLATE/3-documentation.yml
new file mode 100644
index 00000000..c9318575
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/3-documentation.yml
@@ -0,0 +1,17 @@
+name: Feature Request
+description: Suggest improvements to the documentation 📖
+labels: ['documentation']
+body:
+  - type: markdown
+    attributes:
+      value: Thank you for taking the time to submit a suggestion! Please fill out this form as completely as possible.
+  - type: textarea
+    attributes:
+      label: Describe the gap in the current documentation
+      description: A clear and concise description of what area is currently missing or unclear.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you would like to see in the documentation.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..e9cbbd09
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,4 @@
+contact_links:
+  - name: Ask a question 💬
+    url: https://github.com/executablebooks/MyST-Parser/discussions
+    about: Ask questions and discuss ideas with other community members