Merge pull request #330 from AdguardTeam/feature/template_improvement

📜 Docs (n): add question template
AdguardTeam · Feb 5, 2024 · 724e22a · 724e22a
2 parents 58683c1 + db71ff9
commit 724e22a
Show file tree

Hide file tree

Showing 3 changed files with 120 additions and 35 deletions.
diff --git a/.github/ISSUE_TEMPLATE/issue_template.yaml → .github/ISSUE_TEMPLATE/01-bug-report.yaml b/.github/ISSUE_TEMPLATE/issue_template.yaml → .github/ISSUE_TEMPLATE/01-bug-report.yaml
@@ -1,61 +1,113 @@
----
-
 name: 🐞 Bug report
-description: Create a bug report to help us improve AdGuard VPN for iOS.
-labels: [Bug]
+description: If you found something that we should know about
+labels: ["Bug"]
 body:
   - type: markdown
     attributes:
       value: |
         Thanks for taking the time to fill out this bug report!
+
   - type: checkboxes
     attributes:
       label: Please answer the following questions for yourself before submitting an issue.
-      description:
       options:
-        - label: I am running the latest version
-        - label: I checked the documentation and found no answer
+        - label: I checked the [knowledge base](https://adguard-vpn.com/kb/) and found no answer
+          required: true
         - label: I checked to make sure that this issue has not already been filed
-    validations:
-      required: true
+          required: true
+
   - type: input
     id: app_version
     attributes:
-      label: AdGuard VPN version
+      label: AdGuard VPN  version
       description: What version of our application are you running?
-      placeholder: For example, 2.0.7(56)
+      placeholder: For example, 2.2
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Environment
+      description: |
+        Examples:
+          - **OS**: 17.3
+          - **Device**: iPhone 15
+      value: |
+          - OS:
+          - Device:
     validations:
       required: true
+
   - type: dropdown
     id: tunnel_mode
     attributes:
       label: Operating mode
       description:
       multiple: false
       options:
-        - General
+        - VPN
         - Integrated
-  - type: textarea
+    validations:
+      required: true
+
+  - type: dropdown
+    id: exclusions_mode
     attributes:
-      label: Environment
-      description: |
-        Examples:
-          - **OS**: 15.5
-          - **Device and storage size**: iphone 12, 64GB
-      value: |
-          - OS:
-          - Device and storage size:
-      render: markdown
+      label: Exclusions mode
+      description: 
+      multiple: false
+      options:
+        - None, AdGuard VPN app works in integrated mode
+        - Regular
+        - Selective
     validations:
       required: true
+
+  - type: dropdown
+    id: dns_protection
+    attributes:
+      label: Which DNS server do you use?
+      multiple: false
+      options:
+        - None, AdGuard VPN app works in integrated mode
+        - Default
+        - AdGuard DNS
+        - AdGuard DNS Family Protection
+        - AdGuard DNS Non-filtering
+        - Google DNS
+        - Cloudflare DNS
+        - Cloudflare for Families - Malware and Adult Content
+        - Cloudflare for Families - Malware Blocking
+        - Open DNS
+        - Open DNS with Family Shield
+        - Quad9
+        - Custom DNS
+    validations:
+      required: true
+
+  - type: textarea
+    id: custom_dns
+    attributes:
+      label: Custom DNS
+      description: Please provide a link to the custom DNS you use
+      placeholder: If you have enabled DNS from the pre-defined list, skip this step.
+    validations:
+      required: false
+
   - type: textarea
     id: what-happened
     attributes:
       label: Issue Details
-      description: What happened?
-      placeholder: Please describe the steps to reproduce the issue you've experienced.
+      description: Please provide a set of steps to reproduce the issue
+      placeholder:
+      value: |
+        Steps to reproduce:
+        1.
+        2.
+        3.
     validations:
       required: true
+
   - type: textarea
     id: how_it_should_be
     attributes:
@@ -64,6 +116,15 @@ body:
       placeholder: A clear and concise description of what you expected to happen.
     validations:
       required: false
+
+  - type: textarea
+    id: how_it_is
+    attributes:
+      label: Actual Behavior
+      placeholder: A clear description of what happened instead.
+    validations:
+      required: true
+
   - type: textarea
     id: screens
     attributes:
@@ -74,18 +135,19 @@ body:
         Use `<details> </details>` tag to hide screenshots under the spoiler.
       placeholder: If applicable add screenshots explaining your problem.
       value: |
-          <details><summary>Screenshot 1:</summary>
+          <details><summary>Screenshot 1</summary>
 
           <!-- paste screenshot here -->
 
           </details>
     validations:
       required: false
+
   - type: textarea
     id: additional
     attributes:
       label: Additional Information
       description:
       placeholder: Add any other context about the problem here.
     validations:
-      required: false
+      required: false
diff --git a/...UE_TEMPLATE/feature_request_template.yaml → ...ub/ISSUE_TEMPLATE/02-feature-request.yaml b/...UE_TEMPLATE/feature_request_template.yaml → ...ub/ISSUE_TEMPLATE/02-feature-request.yaml
@@ -1,8 +1,6 @@
----
-
 name: 🌱 Feature request
-description: Create a feature request to help us improve AdGuard VPN for iOS.
-labels: ['Feature request']
+description: If you know how AdGuard VPN can be improved
+labels: ["Feature request"]
 body:
   - type: textarea
     id: what-happened
@@ -11,20 +9,20 @@ body:
       description: What happened?
       placeholder: Is your feature request related to a problem? Please add a clear and concise description of what the problem is.
     validations:
-      required: false
+      required: true
+
   - type: textarea
     id: how_it_should_be
     attributes:
       label: Proposed solution
-      description:
       placeholder: Describe the solution you'd like in a clear and concise manner.
     validations:
-      required: false
+      required: true
+
   - type: textarea
     id: additional
     attributes:
       label: Alternative solution
-      description:
       placeholder: A clear and concise description of any alternative solutions or features you've considered.
     validations:
-      required: false
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/03-question.yaml b/.github/ISSUE_TEMPLATE/03-question.yaml
@@ -0,0 +1,25 @@
+name: ❓ Question
+description: If the options above do not work for you
+labels: ["Question"]
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to fill out this form!
+
+  - type: checkboxes
+    attributes:
+      label: Please answer the following questions for yourself before submitting a question.
+      options:
+        - label: I am running the latest version
+        - label: I checked the [knowledge base](https://adguard-vpn.com/kb/) and found no answer
+          required: true
+        - label: I checked to make sure that this issue has not already been filed
+          required: true
+
+  - type: textarea
+    id: question
+    attributes:
+      label: Ask a question
+      placeholder: If you want to know more about how the app works.
+    validations:
+      required: true