From d052fbedf1e8acce60f2a10733b7dd747077432c Mon Sep 17 00:00:00 2001
From: hinto-janai <hinto.janai@protonmail.com>
Date: Wed, 29 May 2024 13:34:32 -0400
Subject: [PATCH] repo: add issue templates (#137)

* add issue templates

* add `question.md`

* fix bug.md

* fix feature.md

* bug.md: fix spacing
---
 .github/ISSUE_TEMPLATE/bug.md        | 45 ++++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/discussion.md | 18 +++++++++++
 .github/ISSUE_TEMPLATE/feature.md    | 21 +++++++++++++
 .github/ISSUE_TEMPLATE/proposal.md   | 24 +++++++++++++++
 .github/ISSUE_TEMPLATE/question.md   | 15 ++++++++++
 5 files changed, 123 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug.md
 create mode 100644 .github/ISSUE_TEMPLATE/discussion.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature.md
 create mode 100644 .github/ISSUE_TEMPLATE/proposal.md
 create mode 100644 .github/ISSUE_TEMPLATE/question.md

diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
new file mode 100644
index 00000000..404bd6ad
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug.md
@@ -0,0 +1,45 @@
+---
+name: 🐞 Bug report
+about: Create a bug report
+title: ''
+labels: ["C-bug"]
+assignees: ''
+
+---
+
+<!--
+Notes:
+- All these fields are optional, add as much or as little info as you like
+- Please search to see if an issue already exists for the bug you encountered
+-->
+
+## Environment
+Example:
+- OS: Windows 11
+- CPU: AMD Ryzen 5 5600X
+- Memory: 16GB
+- Storage: SSD 500GB
+- Cuprate: v1.0.0
+
+## Bug
+What is the bug?
+
+### Expected behavior
+What correct beahvior was expected to happen?
+
+## Steps to reproduce
+Example:
+1. In this environment...
+2. With this config...
+3. Run '...'
+4. See error...
+
+## Log
+If possible, add any related logs to help explain the bug.
+
+Note: please remove any sensitive information from the logs (e.g. IP address).
+
+## Screenshots
+If possible, add screenshots to help explain the bug.
+
+Note: please remove any sensitive information from the screenshot.
diff --git a/.github/ISSUE_TEMPLATE/discussion.md b/.github/ISSUE_TEMPLATE/discussion.md
new file mode 100644
index 00000000..60444617
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/discussion.md
@@ -0,0 +1,18 @@
+---
+name: ⏳ Discussion
+about: Start a discussion on a topic
+title: ''
+labels: ["C-discussion"]
+assignees: ''
+
+---
+
+<!--
+Note: Please search to see if an issue already exists for this discussion.
+-->
+
+## What
+What would you would like to discuss?
+
+## Why
+Why would you would like to discuss this?
diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md
new file mode 100644
index 00000000..dab48112
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature.md
@@ -0,0 +1,21 @@
+---
+name: ✨ Feature request
+about: Request a feature
+title: ''
+labels: ["C-request"]
+assignees: ''
+
+---
+
+<!--
+Note: Please search to see if an issue already exists for this request, or if the feature already exists.
+-->
+
+## Feature
+What is the feature you're requesting?
+
+## Why
+Why should your feature be added?
+
+## Additional context
+Add any other context or screenshots about the feature request.
diff --git a/.github/ISSUE_TEMPLATE/proposal.md b/.github/ISSUE_TEMPLATE/proposal.md
new file mode 100644
index 00000000..132b2b07
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/proposal.md
@@ -0,0 +1,24 @@
+---
+name: 📜 Proposal
+about: Propose an idea and request for comments
+title: ''
+labels: ["C-proposal"]
+assignees: ''
+
+---
+
+<!--
+Note: Please search to see if an issue already exists for this proposal.
+-->
+
+## What
+Describe your proposal.
+
+## Where
+Describe where your proposal will cause changes to.
+
+## Why
+Describe why the proposal is needed.
+
+## How
+Describe how the proposal could be implemented.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644
index 00000000..af426a2d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,15 @@
+---
+name: ❓ Question
+about: Ask a question
+title: ''
+labels: ["C-question"]
+assignees: ''
+
+---
+
+<!--
+Note: Please search to see if an issue already exists for this question.
+-->
+
+## Question
+What question would you like to ask?