summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorLinus Färnstrand <linus@mullvad.net>2023-12-20 11:31:18 +0100
committerLinus Färnstrand <linus@mullvad.net>2023-12-20 11:31:18 +0100
commit0f6214ded9a2915b13187fa224d2cee449b823da (patch)
treefc6be6d8e331aa69145b34f247a168114fb4459d
parent3b8f59c3bec7be191f75f4626cf271857236c839 (diff)
parent175063a15fd9ca530135235d75543715f89a6c8e (diff)
downloadmullvadvpn-0f6214ded9a2915b13187fa224d2cee449b823da.tar.xz
mullvadvpn-0f6214ded9a2915b13187fa224d2cee449b823da.zip
Merge branch 'improve-github-issue-templates-to-reduce-bad-reports-des-501'
-rw-r--r--.github/ISSUE_TEMPLATE.md33
-rw-r--r--.github/ISSUE_TEMPLATE/1-bug-desktop.yml117
-rw-r--r--.github/ISSUE_TEMPLATE/2-bug-android.yml119
-rw-r--r--.github/ISSUE_TEMPLATE/3-bug-ios.yml108
-rw-r--r--.github/ISSUE_TEMPLATE/4-feature-request.yml68
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml10
6 files changed, 422 insertions, 33 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index d58f73acb2..0000000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,33 +0,0 @@
-<!--
- PLEASE READ THIS FIRST
-
-Thank you for wanting to help us improve the Mullvad VPN app by reporting
-issues. But please read this first, since there is a chance you have a better
-option than filing an issue here: If...
-
-* this repository is for questions/suggestions/reports/etc specific to our
-VPN application. If what you are about to post is not related to our app,
-please contact our support team instead: support@mullvad.net
-
-* you ran into a problem with the app - Send a problem report directly from
-within the app. Go to Settings -> Report a problem. That way our support team
-get the error logs they need and will get back to you much faster than anyone will
-on this issue tracker. You can just email support@mullvad.net as well for help.
-
-* you want to suggest a feature or code improvement - First search all existing open
-and closed issues (https://github.com/mullvad/mullvadvpn-app/issues?q=is%3Aissue)
-to see if maybe that feature has already been suggested. If not, go ahead with the issue.
-
-REMOVE THIS ENTIRE COMMENT BLOCK BEFORE POSTING
----------------------------------------------------------
--->
-
-## Issue report
-
-Operating system: <!-- Name AND version of operating system. For example Windows 10 or Android 9 -->
-
-App version: <!-- Version of the Mullvad VPN app you are running. For example 2020.4 -->
-
-### Issue description
-
-<!-- Describe the feature you want to suggest or what it is you want to report an issue about -->
diff --git a/.github/ISSUE_TEMPLATE/1-bug-desktop.yml b/.github/ISSUE_TEMPLATE/1-bug-desktop.yml
new file mode 100644
index 0000000000..e17730c9d9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/1-bug-desktop.yml
@@ -0,0 +1,117 @@
+---
+name: 🐞🖥️ Desktop app bug report (Windows, macOS or Linux)
+description: This form is to report bugs in the desktop Mullvad VPN app.
+labels: ["bug"]
+body:
+ - type: markdown
+ attributes:
+ value: >
+ Thank you for wanting to help us improve the Mullvad VPN app by reporting issues.
+
+ - type: checkboxes
+ id: it-is-a-bug
+ attributes:
+ label: Is it a bug?
+ description: >
+ If you ran into a problem with the app and don't know for sure it is an actual bug,
+ please contact support instead of filing a bug report. Go to
+ `Settings (cogwheel) -> Support -> Report a problem`.
+ That way the support team gets redacted logs from your app and can help you out better.
+ You can also just email them at support@mullvad.net.
+ options:
+ - label: I know this is an issue with the app, and contacting Mullvad support is not relevant.
+ required: true
+
+ - type: checkboxes
+ id: checked-other-issues
+ attributes:
+ label: I have checked if others have reported this already
+ description: >
+ Before you submit a bug report, please look through the
+ [existing issues](https://github.com/mullvad/mullvadvpn-app/issues?q=is%3Aissue)
+ to see if it has already been reported by others. If so, please comment in those threads instead
+ of creating new ones.
+ options:
+ - label: I have checked the issue tracker to see if others have reported similar issues.
+ required: true
+
+ - type: textarea
+ id: current-behavior
+ attributes:
+ label: Current Behavior
+ description: What is the current behavior you experience that you think is not correct?
+ validations:
+ required: true
+
+ - type: textarea
+ id: expected-behavior
+ attributes:
+ label: Expected Behavior
+ description: What is the behavior that you expect to happen instead?
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduction
+ attributes:
+ label: Steps to Reproduce
+ description: >
+ Please provide clear and detailed steps on how to reproduce the issue you are reporting.
+ If it is very hard to reproduce the issue, then there is no guarantee we can locate the bug and fix it.
+ value: |
+ 1. ...
+ 2. ...
+ validations:
+ required: true
+
+ - type: textarea
+ id: logs
+ attributes:
+ label: Failure Logs
+ description: >
+ If relevant, please include logs from the app from the time around when the bug manifested itself.
+
+ Go to settings (cogwheel) -> Support -> Report a problem -> View app logs to see the logs and
+ copy them to here.
+
+ If the graphical part of the app does not work, you can get the logs via the terminal/console
+ by running this command:
+ ```
+ mullvad-problem-report collect --output mullvad-report.log
+ ```
+ And then copy the text from the file `mullvad-report.log` that was just created.
+ render: shell
+
+ - type: input
+ id: os-version
+ attributes:
+ label: Operating system version
+ description: >
+ On what operating system(s) and version(s) have you experienced this bug?
+ If you have experienced it on multiple versions you can write more than one version here.
+
+ For example: "Windows 10" or "macOS 13.4 and macOS 14.0".
+
+ - type: input
+ id: app-version
+ attributes:
+ label: Mullvad VPN app version
+ description: >
+ On what version(s) of the app have you experienced this bug?
+ If you have experienced it on multiple versions you can write more than one version here.
+
+ If you know that this has worked fine before, please include that.
+ For example: "Broke in 2023.8. Worked fine on 2023.7".
+
+ - type: textarea
+ id: additional
+ attributes:
+ label: Additional Information
+ description: Is there any additional information that you can provide?
+
+ - type: markdown
+ id: disclaimer
+ attributes:
+ value: |
+ If we are not able to reproduce the issue, we will likely prioritize fixing other issues we can reproduce.
+ Please do your best to fill out all of the sections above.
diff --git a/.github/ISSUE_TEMPLATE/2-bug-android.yml b/.github/ISSUE_TEMPLATE/2-bug-android.yml
new file mode 100644
index 0000000000..60adf10abc
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2-bug-android.yml
@@ -0,0 +1,119 @@
+---
+name: 🐞📱 Android app bug report
+description: This form is to report bugs in the Android Mullvad VPN app.
+labels: ["bug", "android"]
+body:
+ - type: markdown
+ attributes:
+ value: >
+ Thank you for wanting to help us improve the Mullvad VPN app by reporting issues.
+
+ - type: checkboxes
+ id: it-is-a-bug
+ attributes:
+ label: Is it a bug?
+ description: >
+ If you ran into a problem with the app and don't know for sure it is an actual bug,
+ please contact support instead of filing a bug report. Go to
+ `Settings (cogwheel) -> Support -> Report a problem`.
+ That way the support team gets redacted logs from your app and can help you out better.
+ You can also just email them at support@mullvad.net.
+ options:
+ - label: I know this is an issue with the app, and contacting Mullvad support is not relevant.
+ required: true
+
+ - type: checkboxes
+ id: checked-other-issues
+ attributes:
+ label: I have checked if others have reported this already
+ description: >
+ Before you submit a bug report, please look through the
+ [existing issues](https://github.com/mullvad/mullvadvpn-app/issues?q=is%3Aissue)
+ to see if it has already been reported by others. If so, please comment in those threads instead
+ of creating new ones.
+ options:
+ - label: I have checked the issue tracker to see if others have reported similar issues.
+ required: true
+
+ - type: textarea
+ id: current-behavior
+ attributes:
+ label: Current Behavior
+ description: What is the current behavior you experience that you think is not correct?
+ validations:
+ required: true
+
+ - type: textarea
+ id: expected-behavior
+ attributes:
+ label: Expected Behavior
+ description: What is the behavior that you expect to happen instead?
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduction
+ attributes:
+ label: Steps to Reproduce
+ description: >
+ Please provide clear and detailed steps on how to reproduce the issue you are reporting.
+ If it is very hard to reproduce the issue, then there is no guarantee we can locate the bug and fix it.
+ value: |
+ 1. ...
+ 2. ...
+ validations:
+ required: true
+
+ - type: textarea
+ id: logs
+ attributes:
+ label: Failure Logs
+ description: >
+ If relevant, please include logs from the app from the time around when the bug manifested itself.
+
+ Go to settings (cogwheel) -> Support -> Report a problem -> View app logs to see the logs and
+ copy them to here.
+ render: shell
+
+ - type: input
+ id: os-version
+ attributes:
+ label: Android version
+ description: >
+ On what version(s) of Android have you experienced this bug?
+ If you have experienced it on multiple versions you can write more than one version here.
+
+ Please also include on what Android ROM you have seen this.
+ For example if you run stock Android from your phone vendor, Graphene, LineageOS or similar.
+
+ - type: input
+ id: device-model
+ attributes:
+ label: Device model
+ description: >
+ On what device have you seen this bug? for example "Samsung S22" or "Pixel 7".
+ If you have experienced it on multiple models, you can write more than one here.
+
+ - type: input
+ id: app-version
+ attributes:
+ label: Mullvad VPN app version
+ description: >
+ On what version(s) of the app have you experienced this bug?
+ If you have experienced it on multiple versions you can write more than one version here.
+
+ If you know that this has worked fine before, please include that.
+ For example: "Broke in 2023.8. Worked fine on 2023.7".
+
+ - type: textarea
+ id: additional
+ attributes:
+ label: Additional Information
+ description: Is there any additional information that you can provide?
+
+ - type: markdown
+ id: disclaimer
+ attributes:
+ value: |
+ If we are not able to reproduce the issue, we will likely prioritize fixing other issues we can reproduce.
+ Please do your best to fill out all of the sections above.
diff --git a/.github/ISSUE_TEMPLATE/3-bug-ios.yml b/.github/ISSUE_TEMPLATE/3-bug-ios.yml
new file mode 100644
index 0000000000..35e86ae6b2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/3-bug-ios.yml
@@ -0,0 +1,108 @@
+---
+name: 🐞📱 iOS app bug report
+description: This form is to report bugs in the iOS (iPhone + iPad) Mullvad VPN app.
+labels: ["bug", "ios"]
+body:
+ - type: markdown
+ attributes:
+ value: >
+ Thank you for wanting to help us improve the Mullvad VPN app by reporting issues.
+
+ - type: checkboxes
+ id: it-is-a-bug
+ attributes:
+ label: Is it a bug?
+ description: >
+ If you ran into a problem with the app and don't know for sure it is an actual bug,
+ please contact support instead of filing a bug report. Go to
+ `Settings (cogwheel) -> Report a problem`.
+ That way the support team gets redacted logs from your app and can help you out better.
+ You can also just email them at support@mullvad.net.
+ options:
+ - label: I know this is an issue with the app, and contacting Mullvad support is not relevant.
+ required: true
+
+ - type: checkboxes
+ id: checked-other-issues
+ attributes:
+ label: I have checked if others have reported this already
+ description: >
+ Before you submit a bug report, please look through the
+ [existing issues](https://github.com/mullvad/mullvadvpn-app/issues?q=is%3Aissue)
+ to see if it has already been reported by others. If so, please comment in those threads instead
+ of creating new ones.
+ options:
+ - label: I have checked the issue tracker to see if others have reported similar issues.
+ required: true
+
+ - type: textarea
+ id: current-behavior
+ attributes:
+ label: Current Behavior
+ description: What is the current behavior you experience that you think is not correct?
+ validations:
+ required: true
+
+ - type: textarea
+ id: expected-behavior
+ attributes:
+ label: Expected Behavior
+ description: What is the behavior that you expect to happen instead?
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduction
+ attributes:
+ label: Steps to Reproduce
+ description: >
+ Please provide clear and detailed steps on how to reproduce the issue you are reporting.
+ If it is very hard to reproduce the issue, then there is no guarantee we can locate the bug and fix it.
+ value: |
+ 1. ...
+ 2. ...
+ validations:
+ required: true
+
+ - type: textarea
+ id: logs
+ attributes:
+ label: Failure Logs
+ description: >
+ If relevant, please include logs from the app from the time around when the bug manifested itself.
+
+ Go to settings (cogwheel) -> Report a problem -> View app logs to see the logs and
+ copy them to here.
+ render: shell
+
+ - type: input
+ id: os-version
+ attributes:
+ label: iOS version
+ description: >
+ On what version(s) of iOS have you experienced this bug?
+ If you have experienced it on multiple versions you can write more than one version here.
+
+ - type: input
+ id: app-version
+ attributes:
+ label: Mullvad VPN app version
+ description: >
+ On what version(s) of the app have you experienced this bug?
+ If you have experienced it on multiple versions you can write more than one version here.
+
+ If you know that this has worked fine before, please include that.
+ For example: "Broke in 2023.8. Worked fine on 2023.7".
+
+ - type: textarea
+ id: additional
+ attributes:
+ label: Additional Information
+ description: Is there any additional information that you can provide?
+
+ - type: markdown
+ id: disclaimer
+ attributes:
+ value: |
+ If we are not able to reproduce the issue, we will likely prioritize fixing other issues we can reproduce.
+ Please do your best to fill out all of the sections above.
diff --git a/.github/ISSUE_TEMPLATE/4-feature-request.yml b/.github/ISSUE_TEMPLATE/4-feature-request.yml
new file mode 100644
index 0000000000..f1ad476360
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/4-feature-request.yml
@@ -0,0 +1,68 @@
+---
+name: "🚀 Feature Request"
+description: This form is to suggest a new feature in the Mullvad VPN app.
+title: "[Feature request] "
+labels: ["feature request"]
+body:
+ - type: markdown
+ attributes:
+ value: >
+ Thank you for wanting to help us improve the Mullvad VPN app by suggesting a new feature!
+
+ - type: checkboxes
+ id: checked-other-issues
+ attributes:
+ label: I have checked if others have suggested this already
+ description: >
+ Before you submit a feature request, please look through the existing
+ [feature requests](https://github.com/mullvad/mullvadvpn-app/issues?q=label%3A"feature+request")
+ to see if it has already been suggested by others. If so, please comment in those threads instead
+ of creating new ones.
+ options:
+ - label: I have checked this issue tracker to see if others have reported similar issues.
+ required: true
+
+ - type: textarea
+ id: new-feature
+ attributes:
+ label: Feature description
+ description: >
+ Please describe the feature you would like to see added to the app. Also describe your setup and
+ use-case that makes this feature important to you.
+ validations:
+ required: true
+
+ - type: textarea
+ id: other-solutions
+ attributes:
+ label: Alternative solutions
+ description: >
+ What other ways have you tried to achieve similar results? Or if this feature cannot be
+ added to the app, what alternative ways do you see for moving forward?
+ validations:
+ required: true
+
+ - type: checkboxes
+ id: feature-area
+ attributes:
+ label: Type of feature
+ description: In what way would the app be improved by adding this feature?
+ options:
+ - label: Better privacy/anonymity
+ - label: Better at circumventing censorship
+ - label: Easier to use
+ - label: Other
+
+ - type: checkboxes
+ id: os
+ attributes:
+ label: Operating System
+ description: On what operating system(s) do you think this feature is relevant?
+ options:
+ - label: Android
+ - label: iOS
+ - label: Windows
+ - label: macOS
+ - label: Linux
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000000..84c095b6a3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,10 @@
+---
+blank_issues_enabled: false
+contact_links:
+ - name: Questions and issues not directly related to our VPN application
+ about: >
+ If your question is not related to our VPN application specifically,
+ please contact our support team at support@mullvad.net or visit our help center
+ at https://mullvad.net/help instead of filing an issue.
+ This includes questions/issues about our service, infrastructure, DNS and more.
+ url: https://mullvad.net/help