From 246f6ace804994319f659b2736547b40baf0a9e4 Mon Sep 17 00:00:00 2001
From: zx <zxcvbn@hrzn.email>
Date: Mon, 16 Sep 2024 20:23:19 -0400
Subject: [PATCH] docs: recommended flags

also issue templates
---
 .github/ISSUE_TEMPLATE/bug.yaml             | 22 +++++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.yaml | 22 +++++++++++++++++++++
 README.md                                   |  2 +-
 3 files changed, 45 insertions(+), 1 deletion(-)
 create mode 100644 .github/ISSUE_TEMPLATE/bug.yaml
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml

diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml
new file mode 100644
index 0000000..34286d5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug.yaml
@@ -0,0 +1,22 @@
+# thanks to uYouEnhanced for the issue template:
+# https://github.com/arichornlover/uYouEnhanced/blob/main/.github/ISSUE_TEMPLATE/bug.yaml?plain=1
+
+name: bug
+description: report a bug in cyan
+title: "[bug] "
+labels: bug
+body:
+  - type: checkboxes
+    attributes:
+      label: have you searched the existing issues?
+      options:
+        - label: this is a unique issue. i agree that if this isn't a unique issue, i'll be BLOCKED from the cyan repo
+          required: true
+
+  - type: textarea
+    attributes:
+      label: describe the bug.
+      description: attach videos or screenshots if possible
+    validations:
+      required: true
+
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml
new file mode 100644
index 0000000..e935a2b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -0,0 +1,22 @@
+# thanks to uYouEnhanced for the issue template:
+# https://github.com/arichornlover/uYouEnhanced/blob/main/.github/ISSUE_TEMPLATE/bug.yaml?plain=1
+
+name: feature request
+description: request a feature in cyan
+title: "[feature request] "
+labels: feature-request
+body:
+  - type: checkboxes
+    attributes:
+      label: have you searched the existing issues?
+      options:
+        - label: this is a unique feature request. i agree that if this isn't a unique request, i'll be BLOCKED from the cyan repo
+          required: true
+
+  - type: textarea
+    attributes:
+      label: describe the feature request.
+      description: what exactly are you requesting? can you provide an example where this would be useful?
+    validations:
+      required: true
+
diff --git a/README.md b/README.md
index 826df9c..8c88202 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ a rewrite of [pyzule](https://github.com/asdfzxcvbn/pyzule) that doesn't (comple
 
 ## features
 
-you can open an issue to request a feature :D !!
+you can open an issue to request a feature :D !! also see my [recommended flags](https://github.com/asdfzxcvbn/pyzule-rw/wiki/recommended-flags)
 
 - generate and use shareable .cyan files to configure IPAs!
 - inject deb, dylib, framework, bundle, and appex files/folders