Update issue templates

sandboxie-plus · Jan 6, 2024 · f05fdf2 · f05fdf2
1 parent d037a7e
commit f05fdf2
Show file tree

Hide file tree

Showing 2 changed files with 93 additions and 68 deletions.
diff --git a/.github/ISSUE_TEMPLATE/1-problem_report.yml b/.github/ISSUE_TEMPLATE/1-problem_report.yml
@@ -5,9 +5,14 @@ body:
   - type: markdown
     attributes:
       value: |
-        Thanks for taking the time to fill out this report!
-        To see if your problem has already been reported, you can use the search box on the Issues and Discussions tabs.
-        Also, you may find your answer in our documentation hosted on GitHub: https://sandboxie-plus.github.io/sandboxie-docs
+        Thanks for taking the time to open this report!
+        Before you begin, please use the GitHub search bar to see if your problem has already been reported.
+
+        Also, you may find your answer:
+        1. in the [sandboxie-docs](https://github.com/sandboxie-plus/sandboxie-docs) repository (currently there are [synchronization issues](https://github.com/sandboxie-plus/Sandboxie/discussions/1756) with sandboxie-plus.com)
+        2. in the other [support channels](https://github.com/sandboxie-plus/Sandboxie/discussions/1768#discussioncomment-2503401)
+        3. in the [cached copy](https://github.com/Sandboxie-Website-Archive/sandboxie-website-archive.github.io) of the old Sandboxie forum: `site:https://sandboxie-website-archive.github.io/www.sandboxie.com/old-forums/`
+        4. in the [contributing guidelines](https://github.com/sandboxie-plus/Sandboxie/blob/master/CONTRIBUTING.md)
   - type: textarea
     id: what-happened
     attributes:
@@ -32,6 +37,14 @@ body:
       placeholder: e.g. Whenever I ...
     validations:
       required: false
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expect to see.
+      placeholder: Tell us what the default behavior should be!
+    validations:
+      required: true
   - type: input
     id: sandboxed-program
     attributes:
@@ -40,7 +53,7 @@ body:
         If applicable, in which sandboxed program did you see the problem?
 
         If not, you can type something like "Not relevant".
-      placeholder: e.g. Firefox 113.0.2 64-bit, ....
+      placeholder: e.g. Firefox 121.0 64-bit, ....
     validations:
       required: true
   - type: input
@@ -67,54 +80,44 @@ body:
         - "Not relevant to my request."
     validations:
       required: true
-  - type: textarea
-    id: expected-behavior
-    attributes:
-      label: Expected behavior
-      description: A clear and concise description of what you expect to see.
-      placeholder: Tell us what the default behavior should be!
-    validations:
-      required: true
-  - type: input
-    id: windows-version
-    attributes:
-      label: What is your Windows edition and version?
-      placeholder: "e.g. Windows 10 Pro 22H2 64-bit"
-    validations:
-      required: true
   - type: dropdown
-    id: user-account
+    id: crash-or-not
     attributes:
-      label: "In which Windows account you have this problem?"
-      description: "Note: Built-in user accounts like Guest or Administrator are disabled by default in Windows because they pose a security risk."
+      label: Did the program or any related process close unexpectedly?
+      description: In case of doubt, please take a look at the [crash dump locations](#description-crashdumps) below.
       multiple: true
       options:
-        - "A local account (Standard user)."
-        - "A local account (Administrator)."
-        - "A Microsoft account (Standard user)."
-        - "A Microsoft account (Administrator)."
-        - "An account with secure desktop turned off for UAC prompts."
-        - "An account with UAC protection completely turned off."
-        - "An account with UAC protection set to Always notify."
-        - "I use the built-in Administrator account."
-        - "I use the built-in Administrator with Admin Approval Mode turned on."
-        - "I reproduced it under a Guest account."
-        - "Not relevant to my request."
+        - "Yes, it did. See the link to the .dmp file(s) I have attached here."
+        - "Yes, it did. I'm going to share the .dmp file(s) in a later comment."
+        - "Yes, it did, but I accidentally removed / lost the .dmp file(s)."
+        - "Yes, it did, but no .dmp file has been created in the system."
+        - "Yes, it did, but I don't want to share the .dmp file(s) for privacy reasons."
+        - "Yes, it did, but I don't know how to attach the .dmp file(s)."
+        - "No, not at all."
     validations:
       required: true
   - type: input
-    id: security-software
+    id: crashdumps
     attributes:
-      label: Please mention any installed security software
-      description: Even if the real-time protection is disabled, any security solution could still conflict with Sandboxie.
-      placeholder: e.g. Microsoft Defender Antivirus
-    validations:
-      required: true
+      label: Crash dump
+      description: |
+        List of crash dump locations to check out:
+        - C:\\Users\\%Username%\\AppData\\Local\\CrashDumps
+        - C:\\Windows\\Minidump
+        - C:\\Sandbox\\%User%\\DefaultBox\\user\\current\\AppData\\Local\\CrashDumps
+        - C:\\Sandbox\\%USER%\\%SANDBOX% (only if you previously set EnableMiniDump=y in the sandbox section of your Sandboxie.ini file)
+        - C:\\Windows\\MEMORY.DMP (known as %SystemRoot%\\MEMORY.DMP)
+
+        If applicable, provide a direct link containing the .dmp file(s) for your crash issue!
+        See also: [Generate a kernel or complete crash dump](https://learn.microsoft.com/en-us/troubleshoot/windows-client/performance/generate-a-kernel-or-complete-crash-dump) | [Driver Verifier - tracking down a misbehaving driver](https://answers.microsoft.com/en-us/windows/forum/windows_10-update/driver-verifier-tracking-down-a-mis-behaving/f5cb4faf-556b-4b6d-95b3-c48669e4c983).
+
+        Tip: You can upload the .dmp file(s) on a file storage service, then share the resulting link below.
+      placeholder: https://
   - type: input
     id: sandboxie-version
     attributes:
-      label: What version of Sandboxie are you running?
-      placeholder: e.g. Sandboxie Plus 1.9.6 64-bit
+      label: What version of Sandboxie are you running now?
+      placeholder: e.g. Sandboxie Plus 1.12.6 64-bit
     validations:
       required: true
   - type: dropdown
@@ -132,9 +135,9 @@ body:
   - type: input
     id: regression
     attributes:
-      label: Is it a regression?
-      description: If applicable, specify in which Sandboxie version this problem was introduced the first time (including any pre-release version).
-      placeholder: e.g. Since 5.62.1 64-bit
+      label: Is it a regression from previous versions?
+      description: If you intend to test multiple versions, specify in which Sandboxie version this problem was introduced the first time (including any pre-release version).
+      placeholder: e.g. The issue was introduced the first time in 5.62.1 64-bit
   - type: dropdown
     id: box-types
     attributes:
@@ -167,40 +170,59 @@ body:
       - "Not relevant to my request."
     validations:
       required: true
+  - type: input
+    id: windows-version
+    attributes:
+      label: What is your Windows edition and version?
+      placeholder: "e.g. Windows 10 Pro 22H2 64-bit"
+    validations:
+      required: true
+  - type: dropdown
+    id: user-account
+    attributes:
+      label: "In which Windows account you have this problem?"
+      description: "Please note that built-in user accounts like Guest or Administrator are disabled by default in Windows because they pose a security risk."
+      multiple: true
+      options:
+        - "A local account (Standard user)."
+        - "A local account (Administrator)."
+        - "A Microsoft account (Standard user)."
+        - "A Microsoft account (Administrator)."
+        - "An account with secure desktop turned off for UAC prompts."
+        - "An account with UAC protection completely turned off."
+        - "An account with UAC protection set to Always notify."
+        - "I use the built-in Administrator account."
+        - "I use the built-in Administrator with Admin Approval Mode turned on."
+        - "I reproduced it under a Guest account."
+        - "Not relevant to my request."
+    validations:
+      required: true
+  - type: input
+    id: security-software
+    attributes:
+      label: Please mention any installed security software
+      description: |
+        Please note that third-party security solutions can still conflict even when their real-time protection is turned off, so you may want to consider a temporary uninstall with reboot to rule out any issue with Sandboxie. See also: [Reporting issues to third-party vendors in case of evident conflicts](https://github.com/sandboxie-plus/Sandboxie/issues/2025#issuecomment-1200110235).
+      placeholder: e.g. Microsoft Defender Antivirus
+    validations:
+      required: true
   - type: textarea
     id: policy-settings
     attributes:
       label: Did you previously enable some security policy settings outside Sandboxie?
       description: |
-        For example in gpedit.msc, secpol.msc, Windows Defender Exploit protection settings, or other management tools like parental controls.
+        For example in gpedit.msc, secpol.msc, Windows Defender Exploit protection settings, management tools like parental controls, Microsoft Intune, etc.
 
         Tip: You may consider to turn off non-default Windows settings.
       placeholder: |
         e.g. I enabled the following security / policy settings outside Sandboxie:
         ....
-  - type: input
-    id: crashdumps
-    attributes:
-      label: Crash dump
-      description: |
-        If applicable, provide a direct link containing the .dmp file(s) for your crash issue!
-
-        List of crash dump locations:
-        - C:\\Users\\%Username%\\AppData\\Local\\CrashDumps
-        - C:\\Windows\\Minidump
-        - C:\\Sandbox\\%User%\\DefaultBox\\user\\current\\AppData\\Local\\CrashDumps
-        - C:\\Sandbox\\%USER%\\%SANDBOX% (only if you previously set EnableMiniDump=y in the sandbox section of your Sandboxie.ini file)
-        - C:\\Windows\\MEMORY.DMP (known as %SystemRoot%\\MEMORY.DMP)
-        See also: [Generate a kernel or complete crash dump](https://learn.microsoft.com/en-us/troubleshoot/windows-client/performance/generate-a-kernel-or-complete-crash-dump) | [Driver Verifier - tracking down a misbehaving driver](https://answers.microsoft.com/en-us/windows/forum/windows_10-update/driver-verifier-tracking-down-a-mis-behaving/f5cb4faf-556b-4b6d-95b3-c48669e4c983)
-
-        Tip: You can upload the .dmp file(s) on a file storage service, then share the resulting link below.
-      placeholder: https://
   - type: input
     id: logs
     attributes:
       label: Trace log
       description: |
-        Please consider to take one or more logs for Resource Access issues. For instructions, see https://git.io/Jwj2y
+        Please consider to take one or more logs for Resource Access issues. For instructions, see [Sandboxie Trace](https://git.io/Jwj2y).
 
         Tip: You can compress multiple log files in a .zip archive to upload on a file storage service, then share the resulting link below.
       placeholder: https://
@@ -210,8 +232,6 @@ body:
       label: Sandboxie.ini configuration
       description: |
         If applicable, consider to attach your Sandboxie.ini settings (usually located in `C:\Windows` or in the installation folder).
-
-        Tip: If the content is too long, you are recommended to copy the settings on https://gist.github.com and share the resulting link below.
       placeholder: |
         [GlobalSettings]
         .....

diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.yml b/.github/ISSUE_TEMPLATE/2-feature_request.yml
@@ -5,9 +5,14 @@ body:
   - type: markdown
     attributes:
       value: |
-        Thanks for taking the time to fill out this request!
-        To see if your feature request has already been reported, you can use the search box on the Issues and Discussions tabs.
-        Also, you may find your answer in our documentation hosted on GitHub: https://sandboxie-plus.github.io/sandboxie-docs
+        Thanks for taking the time to open this request!
+        Before you begin, please use the GitHub search bar to see if your feature request has already been reported.
+
+        Also, you may find your answer:
+        1. in the [sandboxie-docs](https://github.com/sandboxie-plus/sandboxie-docs) repository (currently there are [synchronization issues](https://github.com/sandboxie-plus/Sandboxie/discussions/1756) with sandboxie-plus.com)
+        2. in the other [support channels](https://github.com/sandboxie-plus/Sandboxie/discussions/1768#discussioncomment-2503401)
+        3. in the [cached copy](https://github.com/Sandboxie-Website-Archive/sandboxie-website-archive.github.io) of the old Sandboxie forum: `site:https://sandboxie-website-archive.github.io/www.sandboxie.com/old-forums/`
+        4. in the [contributing guidelines](https://github.com/sandboxie-plus/Sandboxie/blob/master/CONTRIBUTING.md)
   - type: textarea
     id: describe-feature
     attributes: