aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorMathijs van Veluw <[email protected]>2024-08-20 21:25:28 +0200
committerGitHub <[email protected]>2024-08-20 21:25:28 +0200
commitcbdb5657f1bd234a98972df5c11e0492f10f08a8 (patch)
tree2b095114fd544218aa71f3953f699f1bc0f9da63 /.github
parent669b9db7583327f506a94da03c3cbb6838c0062e (diff)
downloadvaultwarden-cbdb5657f1bd234a98972df5c11e0492f10f08a8.tar.gz
vaultwarden-cbdb5657f1bd234a98972df5c11e0492f10f08a8.zip
Update issue template (#4876)
Updated the issue template to use a form and guide users to provide all information useful to troublshoot issues Als updated links to prefer the usage of GitHub Discussions. Signed-off-by: BlackDex <[email protected]>
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md66
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml139
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml10
3 files changed, 144 insertions, 71 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 128c5f58..00000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,66 +0,0 @@
----
-name: Bug report
-about: Use this ONLY for bugs in vaultwarden itself. Use the Discourse forum (link below) to request features or get help with usage/configuration. If in doubt, use the forum.
-title: ''
-labels: ''
-assignees: ''
-
----
-<!--
- # ###
- NOTE: Please update to the latest version of vaultwarden before reporting an issue!
- This saves you and us a lot of time and troubleshooting.
- See:
- * https://github.com/dani-garcia/vaultwarden/issues/1180
- * https://github.com/dani-garcia/vaultwarden/wiki/Updating-the-vaultwarden-image
- # ###
--->
-
-<!--
-Please fill out the following template to make solving your problem easier and faster for us.
-This is only a guideline. If you think that parts are unnecessary for your issue, feel free to remove them.
-
-Remember to hide/redact personal or confidential information,
-such as passwords, IP addresses, and DNS names as appropriate.
--->
-
-### Subject of the issue
-<!-- Describe your issue here. -->
-
-### Deployment environment
-
-<!--
- =========================================================================================
- Preferably, use the `Generate Support String` button on the admin page's Diagnostics tab.
- That will auto-generate most of the info requested in this section.
- =========================================================================================
--->
-
-<!-- The version number, obtained from the logs (at startup) or the admin diagnostics page -->
-<!-- This is NOT the version number shown on the web vault, which is versioned separately from vaultwarden -->
-<!-- Remember to check if your issue exists on the latest version first! -->
-* vaultwarden version:
-
-<!-- How the server was installed: Docker image, OS package, built from source, etc. -->
-* Install method:
-
-* Clients used: <!-- web vault, desktop, Android, iOS, etc. (if applicable) -->
-
-* Reverse proxy and version: <!-- if applicable -->
-
-* MySQL/MariaDB or PostgreSQL version: <!-- if applicable -->
-
-* Other relevant details:
-
-### Steps to reproduce
-<!-- Tell us how to reproduce this issue. What parameters did you set (differently from the defaults)
-and how did you start vaultwarden? -->
-
-### Expected behaviour
-<!-- Tell us what you expected to happen -->
-
-### Actual behaviour
-<!-- Tell us what actually happened -->
-
-### Troubleshooting data
-<!-- Share any log files, screenshots, or other relevant troubleshooting data -->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 00000000..c0cb4559
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,139 @@
+name: Bug Report
+description: File a bug report
+labels: ["bug"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this bug report!
+
+ Please do not submit feature requests or ask for help on how to configure Vaultwarden here.
+
+ The [GitHub Discussions](https://github.com/dani-garcia/vaultwarden/discussions/) has sections for Questions and Ideas.
+
+ Also, make sure you are running the [Latest Release](https://github.com/dani-garcia/vaultwarden/releases) of Vaultwarden!
+ And search for existing open or closed issues or discussions regarding your topic before posting.
+ - type: textarea
+ id: support-string
+ attributes:
+ label: Vaultwarden Support String
+ description: Output of the **Generate Support String** from the `/admin/diagnostics` page.
+ placeholder: |
+ 1. Go to the Vaultwarden Admin of your instance https://example.domain.tld/admin/diagnostics
+ 2. Click on `Generate Support String`
+ 3. Click on `Copy To Clipboard`
+ 4. Replace this text by pasting it into this textarea without any modifications
+ validations:
+ required: true
+ - type: textarea
+ id: reproduce
+ attributes:
+ label: Steps To Reproduce
+ description: How can we reproduce the behavior.
+ value: |
+ 1. Go to '...'
+ 2. Click on '....'
+ 3. Scroll down to '....'
+ 4. Click on '...'
+ 5. Etc '...'
+ validations:
+ required: true
+ - type: textarea
+ id: expected
+ attributes:
+ label: Expected Result
+ description: A clear and concise description of what you expected to happen.
+ validations:
+ required: true
+ - type: textarea
+ id: actual
+ attributes:
+ label: Actual Result
+ description: A clear and concise description of what is happening.
+ validations:
+ required: true
+ - type: textarea
+ id: screenshots
+ attributes:
+ label: Screenshots or Videos
+ description: If applicable, add screenshots and/or a short video to help explain your problem.
+ - type: textarea
+ id: logs
+ attributes:
+ label: Logs
+ description: Provide the logs generated by Vaultwarden generated during the time this issue occurs.
+ render: text
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Additional Context
+ description: Add any other context about the problem here.
+ - type: dropdown
+ id: os
+ attributes:
+ label: Host/Server Operating System
+ description: On what operating system are running the Vaultwarden server?
+ multiple: true
+ options:
+ - Linux
+ - Windows
+ - macOS
+ - Android
+ - Other
+ validations:
+ required: true
+ - type: input
+ id: os-version
+ attributes:
+ label: Operating System Version
+ description: What version of the operating system(s) are you seeing the problem on?
+ placeholder: ex. Arch Linux, Ubuntu 24.04, Windows 11
+ - type: dropdown
+ id: deployment
+ attributes:
+ label: Deployment method
+ description: How did you deployed Vaultwarden?
+ multiple: false
+ options:
+ - Official Container Image
+ - Build from source
+ - OS Package (apt, yum/dnf, pacman, apk, nix, ...)
+ - Manually Extracted from Container Image
+ - Downloaded from GitHub Actions Release Workflow
+ - Other method
+ validations:
+ required: true
+ - type: textarea
+ id: deployment-other
+ attributes:
+ label: Custom deployment method
+ description: If you deployed Vaultwarden via any other method, please describe how.
+ - type: input
+ id: version
+ attributes:
+ label: Vaultwarden Build Version
+ description: What version of Vaultwarden are you running?
+ placeholder: ex. v1.31.0 or v1.32.0-3466a804
+ validations:
+ required: true
+ - type: dropdown
+ id: clients
+ attributes:
+ label: Clients
+ description: What client(s) are you seeing the problem on?
+ multiple: true
+ options:
+ - Web Vault
+ - Browser Extension
+ - CLI
+ - Desktop
+ - Android
+ - iOS
+ validations:
+ required: true
+ - type: input
+ id: client-version
+ attributes:
+ label: Client Version
+ description: What version(s) of the client(s) are you seeing the problem on?
+ placeholder: ex. v2024.7.2
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 51a76d39..5796d8e6 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,8 +1,8 @@
blank_issues_enabled: false
contact_links:
- - name: Discourse forum for vaultwarden
- url: https://vaultwarden.discourse.group/
- about: Use this forum to request features or get help with usage/configuration.
- - name: GitHub Discussions for vaultwarden
+ - name: GitHub Discussions for Vaultwarden
url: https://github.com/dani-garcia/vaultwarden/discussions
- about: An alternative to the Discourse forum, if this is easier for you.
+ about: Use the discussions to request features or get help with usage/configuration.
+ - name: Discourse forum for Vaultwarden
+ url: https://vaultwarden.discourse.group/
+ about: An alternative to the GitHub Discussions, if this is easier for you.