From 1f90ff2510260f0837fa8b467422d409ef2e5404 Mon Sep 17 00:00:00 2001
From: Yashodhan <54112038+YJDoc2@users.noreply.github.com>
Date: Fri, 12 Jul 2024 18:35:08 +0530
Subject: [PATCH] Add issue templates (#2829)

* Add issue templates

This adds Bug report and Feature request issue templates.

Signed-off-by: Yashodhan Joshi <yjdoc2@gmail.com>

* Change the templates to forms

Signed-off-by: Yashodhan Joshi <yjdoc2@gmail.com>

---------

Signed-off-by: Yashodhan Joshi <yjdoc2@gmail.com>
---
 .github/ISSUE_TEMPLATE/BUG_REPORT.yml  | 47 ++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/FEATURE_REQ.yml | 44 ++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml      |  1 +
 3 files changed, 92 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.yml
 create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQ.yml
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml

diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml
new file mode 100644
index 00000000..1df6373a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml
@@ -0,0 +1,47 @@
+name: Bug Report
+description: File a bug report.
+title: "[Bug]: "
+labels: ["kind/bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: description
+    attributes:
+      label: Bug Description
+      description: A clear and concise description of what the bug is 
+      placeholder: Youki crashes when running...
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: Steps to Reproduce
+      description: How can we reproduce this, or how did you run into this?
+      placeholder: |
+        1. Create '...'
+        2. Run youki as '....'
+    validations:
+      required: true
+  - type: textarea
+    id: expectations
+    attributes:
+      label: Expectation
+      description: What did you expect to happen instead?
+      placeholder: Youki should have ran the container...
+  - type: textarea
+    id: info
+    attributes:
+      label: System and Setup Info
+      description: Give us more info about the environment and setup
+      placeholder: |
+        Add information about your system. If Youki is compiling and running on your system, please add o/p of `youki info` .
+        If you are experiencing issues in compiling Youki, or related deps, please add details regarding your setup, dependencies etc. 
+        Also if you are running Youki via something else (Docker, podman, k8s) add its info here.
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Please add any additional context about the issue
diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQ.yml b/.github/ISSUE_TEMPLATE/FEATURE_REQ.yml
new file mode 100644
index 00000000..417f237f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/FEATURE_REQ.yml
@@ -0,0 +1,44 @@
+name: Feature Request
+description: Suggest an idea for this project
+title: "[FEATURE]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: Thank you for creating a feature request!
+  - type: textarea
+    id: background
+    attributes:
+      label: Background
+      description: Please add required background information for this request
+      placeholder: I'm working on a project where...
+  - type: textarea
+    id: request
+    attributes:
+      label: Feature Request
+      description: Description of the feature you are requesting
+      placeholder: I'm proposing that youki should...
+    validations:
+      required: true
+  - type: textarea
+    id: problem-desc
+    attributes:
+      label: Is the request related to some problem running youki?
+      description: A clear and concise description of what the problem is.
+      placeholder: I'm always frustrated when [...]
+  - type: textarea
+    id: expectations
+    attributes:
+      label: Proposed Solution
+      description: A clear and concise description of what you want to happen.
+      placeholder: Youki should ....
+  - type: textarea
+    id: considerations
+    attributes:
+      label: Considerations
+      description: A clear and concise description of any alternative solutions, features and issues you've considered.
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional Context
+      description: Please add any additional context or screenshots here.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..36eda2dc
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: true # allow people to not use forms, just directly create issues