From f642b7828c390633e9bbe96f55e2ed5705fe4daa Mon Sep 17 00:00:00 2001
From: gretzke <daniel@gretzke.de>
Date: Tue, 2 Jul 2024 02:21:44 +0200
Subject: [PATCH] add issue templates

---
 .github/ISSUE_TEMPLATE/BUG_REPORT.yaml        | 31 ++++++++++++++++
 .../ISSUE_TEMPLATE/FEATURE_IMPROVEMENT.yaml   | 36 +++++++++++++++++++
 2 files changed, 67 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.yaml
 create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_IMPROVEMENT.yaml

diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml
new file mode 100644
index 0000000..7979d0a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml
@@ -0,0 +1,31 @@
+name: Bug report
+description: File a bug report to help us improve the code
+title: "[Bug]: "
+labels: ["bug"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please check that the bug is not already being tracked.
+  - type: textarea
+    attributes:
+      label: Describe the bug
+      description: Provide a clear and concise description of what the bug is and which contracts it affects.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: Provide a clear and concise description of the desired fix.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: To Reproduce
+      description: If you have written tests to showcase the bug, what can we run to reproduce the issue?
+      placeholder: "git checkout <branchname> / forge test --isolate --mt <testName>"
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: If there is any additional context needed like a dependency or integrating contract that is affected please describe it below.
diff --git a/.github/ISSUE_TEMPLATE/FEATURE_IMPROVEMENT.yaml b/.github/ISSUE_TEMPLATE/FEATURE_IMPROVEMENT.yaml
new file mode 100644
index 0000000..098688d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/FEATURE_IMPROVEMENT.yaml
@@ -0,0 +1,36 @@
+name: Feature Improvement
+description: Suggest an improvement.
+labels: ["triage"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please ensure that the feature has not already been requested.
+  - type: dropdown
+    attributes:
+      label: Component
+      description: Which area of code does your idea improve?
+      multiple: true
+      options:
+        - Gas Optimization
+        - General design optimization (improving efficiency, cleanliness, or developer experience)
+        - Documentation
+  - type: textarea
+    attributes:
+      label: Describe the suggested feature and problem it solves.
+      description: Provide a clear and concise description of what feature you would like to see, and what problems it solves.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Describe the desired implementation.
+      description: If possible, provide a suggested architecture change or implementation.
+  - type: textarea
+    attributes:
+      label: Describe alternatives.
+      description: If possible, describe the alternatives you've considered, or describe the current functionality and how it may be sub-optimal.
+  - type: textarea
+    attributes:
+      label: Additional context.
+      description: Please list any additional dependencies or integrating contacts that are affected.