From de7084918e20fc75de3962eff0a05b989a66b880 Mon Sep 17 00:00:00 2001
From: Matthew Sevey <mjsevey@gmail.com>
Date: Wed, 12 Jul 2023 17:05:19 -0400
Subject: [PATCH] add issue template (#6)

---
 .github/ISSUE_TEMPLATE/bug-report.yml      | 80 ++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml          |  1 +
 .github/ISSUE_TEMPLATE/feature-request.yml | 16 +++++
 .github/ISSUE_TEMPLATES_TODO/README.md     |  1 -
 4 files changed, 97 insertions(+), 1 deletion(-)
 create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml
 delete mode 100644 .github/ISSUE_TEMPLATES_TODO/README.md

diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
new file mode 100644
index 0000000..f0682ca
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,80 @@
+name: Bug Report
+description: File a bug report to inform the community on your awesome finding!
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for filling out this bug report!
+  - type: textarea
+    id: version
+    attributes:
+      label: Version of Git SHA
+      description: What version of the code are you running, or what git commit sha are you building from?
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        Environment
+  - type: textarea
+    id: os
+    attributes:
+      label: System OS
+      description: MacOS, Windows, Linux, etc
+    validations:
+      required: true
+  - type: textarea
+    id: tools
+    attributes:
+      label: Installed tools
+      description: e.g. docker, makefiles, etc.
+  - type: textarea
+    id: others
+    attributes:
+      label: Others
+      description: >
+        e.g. flag options, celestia config file changes, resources
+        limitation(like cpu, ram limit, swap etc.)
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce it
+      description: What steps have you made to reproduce it?
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+  - type: textarea
+    id: expectation
+    attributes:
+      label: Expected result
+      description: What do you expect to happen as a final result?
+      placeholder: Let us know what is expected
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual result
+      description: What do you see happened instead as a final result?
+      placeholder: >
+        This is the crucial part in detecting the root cause of the issue
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: >
+        Please copy and paste any relevant log(max 20 lines) output. This will
+        be automatically formatted into code, so no need for backticks. Or paste
+        gists, pastebins links here
+      render: Shell
+  - type: textarea
+    id: misc
+    attributes:
+      label: Notes
+      description: Is there anything else we need to know?
+      placeholder: >
+        Maybe, you have other ways to repro or what side effects there are if
+        changing steps
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..0086358
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: true
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
new file mode 100644
index 0000000..91c680c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,16 @@
+name: Feature Request
+description: >
+  Request a new feature to inform the community on what will be beneficial for
+  the project!
+title: "[Feature Request]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for taking your time and creating a new feature request!
+  - type: textarea
+    id: ideas
+    attributes:
+      label: Implementation ideas
+      description: What ideas do you have on how to implement this?
diff --git a/.github/ISSUE_TEMPLATES_TODO/README.md b/.github/ISSUE_TEMPLATES_TODO/README.md
deleted file mode 100644
index 90011d2..0000000
--- a/.github/ISSUE_TEMPLATES_TODO/README.md
+++ /dev/null
@@ -1 +0,0 @@
-The directory has the `_TODO` prefix so that it isn't used. Once we have Issue Templates ready.