From e146728ce5b1efe52c7a75c67abc2520c07f00bb Mon Sep 17 00:00:00 2001
From: Chris Sewell <chrisj_sewell@hotmail.com>
Date: Sat, 3 Jun 2023 00:13:58 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20Update=20docs=20(#285)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
---
 .github/ISSUE_TEMPLATE/bug_report.yml  | 63 ++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml      |  4 ++
 .github/ISSUE_TEMPLATE/enhancement.yml | 44 ++++++++++++++++++
 3 files changed, 111 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 00000000..df7e2306
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,63 @@
+name: Report a problem 🐛
+description: Problem reports are for when something behaves incorrectly, or differently from how you'd expect.
+labels: [bug]
+body:
+- type: textarea
+  id: describe
+  attributes:
+    label: Describe the bug
+    description: |
+      Provide a short description (one or two sentences) about the problem. What did you expect to happen, and what is actually happening?
+
+      If possible, provide screenshots or error messages that you've encountered.
+    value: |
+      **context**
+      When I do ___.
+
+      **expectation**
+      I expected ___ to occur.
+
+      **bug**
+      But instead ___ happens
+      Here's an error message I ran into...
+
+      **problem**
+      This is a problem for people doing ___ because ___.
+
+  validations:
+    required: true
+
+- type: textarea
+  id: reproduce
+  attributes:
+    label: Reproduce the bug
+    description: |
+      Provide information that others may use to re-produce this behavior.
+      For example:
+
+      - Step-by-step instructions that others can follow.
+      - Links to a website that demonstrates the bug.
+      - Information about certain conditions that the bug pops up.
+
+    placeholder: |
+      1. Go to '...'
+      2. Click on '....'
+      3. Scroll down to '....'
+      4. See error
+  validations:
+    required: true
+
+- type: textarea
+  id: environment
+  attributes:
+    label: List your environment
+    description: |
+      List the environment needed to reproduce the error.
+      Here are a few ideas:
+
+      - Version of markdown-it-py
+      - Versions of mdit-py-plugins
+      - The version of Python you're using.
+      - Your operating system
+  validations:
+    required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..46e5f734
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,4 @@
+contact_links:
+  - name: Questions or general discussion ❓🗣️
+    url: https://github.com/executablebooks/markdown-it-py/discussions
+    about: Use Disussions for general conversations that aren't meant for actionable Issues.
diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml
new file mode 100644
index 00000000..68eac5e6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/enhancement.yml
@@ -0,0 +1,44 @@
+name: Request an enhancement 💡
+description: Suggest an idea for this project
+labels: [enhancement]
+body:
+
+- type: textarea
+  id: context
+  attributes:
+    label: Context
+    description: |
+      - Provide background to help others understand this issue.
+      - Describe the problem or need you'd like to address.
+  validations:
+    required: true
+
+
+- type: textarea
+  id: proposal
+  attributes:
+    label: Proposal
+    description: |
+      - A simple and clear description of what you're proposing.
+      - Ideas or constraints for how to implement this proposal
+      - Important considerations to think about or discuss
+  validations:
+    required: false
+
+
+- type: textarea
+  id: tasks
+  attributes:
+    label: Tasks and updates
+    description: |
+      Use this area to track ongoing work and to-do items.
+      The more specific the better.
+
+      _If you can't think of anything then just leave this blank and we can fill it in later! This can be filled in as we understand more about an issue._
+
+    placeholder: |
+      - [ ] Discuss and decide on what to do...
+      - [ ] Implement partial feature A...
+
+  validations:
+    required: false