diff --git a/.github/ISSUE_TEMPLATE/blank.yml b/.github/ISSUE_TEMPLATE/blank.yml new file mode 100644 index 0000000..2bed8eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank.yml @@ -0,0 +1,18 @@ +name: Blank Issue +description: Reserved for developers. Use the bug report or feature request templates instead. + +body: + - type: markdown + attributes: + value: | + # READ THIS BEFORE OPENING AN ISSUE + + This form is only meant for Vesktop developers. If you don't know what you're doing, + please use the bug report or feature request templates instead. + + - type: textarea + id: content + attributes: + label: Content + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 08405e6..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - - - -**Describe the bug** - - - -**To Reproduce** - - - -**Expected behavior** - - - -**Screenshots** - - - -**Desktop (please complete the following information):** - - OS/Distro: [e.g. Windows / Fedora Linux / MacOs] - - Desktop Environment (linux only): [e.g. gnome, kde, sway] - - Version: [e.g. 22] - -**Command line output** - - - -``` -paste inside these backticks -``` - -**Additional context** - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..a9aec1f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,106 @@ +name: 🐛 Bug / Crash Report +description: Create a bug or crash report for Vesktop +labels: [bug] +title: "[Bug] " + +body: + - type: markdown + attributes: + value: | + **Thanks 🩷 for taking the time to fill out this bug report! Before proceeding, please read the following** + + Make sure a similar issue doesn't already exist by [searching the existing issues](https://github.com/Vencord/Vesktop/issues?q=is%3Aissue) for keywords! + + Make sure both Vesktop and Vencord are fully up to date. You can update Vencord by right-clicking the Vesktop tray icon and pressing "Update Vencord" + + Do not report any of the following issues: + - Purely graphical glitches like flickering, scaling issues, etc: Issue with your gpu. Nothing we can do, update drivers or disable hardware acceleration + - Vencord related issues: This is the Vesktop repo, not Vencord + - Screenshare not starting / black screening on Linux: Issue with your desktop environment, specifically its xdg-desktop-portal + + Linux users: Please only report issues with supported packages (flatpak and any builds from the README / releases). + We do not support other packages, like the AUR or Nix packages, so please first make sure your issue is reproducible with official releases, + like [our Flatpak](https://flathub.org/apps/dev.vencord.Vesktop) or [AppImage](https://vencord.dev/download/vesktop/amd64/appimage) + + - type: input + id: discord + attributes: + label: Discord Account + description: Who on Discord is making this request? Not required but encouraged for easier follow-up + placeholder: username#0000 + validations: + required: false + + - type: input + id: os + attributes: + label: Operating System + description: What operating system are you using (eg Windows 10, macOS Big Sur, Ubuntu 20.04)? + placeholder: Windows 10 + validations: + required: true + + - type: input + id: linux-de + attributes: + label: Linux Only ~ Desktop Environment + description: If you are on Linux, what Desktop environment are you using (eg GNOME, KDE, XFCE)? Are you using Wayland or Xorg? + placeholder: Gnome on Wayland + validations: + required: false + + - type: textarea + id: bug-description + attributes: + label: What happens when the bug or crash occurs? + description: Where does this bug or crash occur, when does it occur, etc. + placeholder: The bug/crash happens sometimes when I do ..., causing this to not work/the app to crash. I think it happens because of ... + validations: + required: true + + - type: textarea + id: expected-behaviour + attributes: + label: What is the expected behaviour? + description: Simply detail what the expected behaviour is. + placeholder: I expect Vencord/Discord to open the ... page instead of ..., it prevents me from doing ... + validations: + required: true + + - type: textarea + id: steps-to-take + attributes: + label: How do you recreate this bug or crash? + description: Give us a list of steps in order to recreate the bug or crash. + placeholder: | + 1. Do ... + 2. Then ... + 3. Do this ..., ... and then ... + 4. Observe "the bug" or "the crash" + validations: + required: true + + - type: textarea + id: debug-logs + attributes: + label: Debug Logs + description: Run vesktop from the command line. Include the relevant command line output here + value: | + ``` + Replace this text with your crash-log. Do not remove the backticks + ``` + validations: + required: true + + - type: checkboxes + id: agreement-check + attributes: + label: Request Agreement + description: We only accept reports for bugs that happen on supported and up to date Vesktop releases + options: + - label: I have searched the existing issues and found no similar issue + required: true + - label: I am using the latest Vesktop and Vencord versions + required: true + - label: This issue occurs on an official release (not just the AUR or Nix packages) + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..807b463 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Vencord Support Server + url: https://discord.gg/D9uwnFnqmd + about: If you need help regarding Vesktop or Vencord, please join our support server! diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 48d5f81..0000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Custom issue template -about: Describe this issue template's purpose here. -title: '' -labels: '' -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..ab2db83 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,72 @@ +name: 🛠️ Feature Request +description: Create a feature request for Vesktop +labels: [bug] +title: "[Bug] <title>" + +body: + - type: markdown + attributes: + value: | + **Thanks 🩷 for taking the time to fill out this request! Before proceeding, please read the following** + + Make sure a similar request doesn't already exist by [searching the existing issues](https://github.com/Vencord/Vesktop/issues?q=is%3Aissue) for keywords! + + This form is only meant for **Vesktop feature requests**. + For plugin requests or Vencord feature requests, go [here](https://github.com/Vencord/plugin-requests/issues/new?template=request.yml) instead! + + - type: input + id: discord + attributes: + label: Discord Account + description: Who on Discord is making this request? Not required but encouraged for easier follow-up + placeholder: username#0000 + validations: + required: false + + - type: textarea + id: motivation + attributes: + label: Motivation + description: If your feature request related to a problem? Please describe + placeholder: I'm always frustrated when ..., I think it would be better if ... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Solution + description: Describe the solution you'd like + placeholder: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives + description: Describe alternatives you've considered + placeholder: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context here. Screenshots or mockups could help greatly + validations: + required: false + + - type: checkboxes + id: agreement-check + attributes: + label: Request Agreement + description: This form is only for Vesktop feature requests. If the following don't apply, re-read the introduction text + options: + - label: I have searched the existing issues and found no similar issue + required: true + - label: This is not a plugin request + required: true + - label: This is not a Vencord feature request + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 11fc491..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here.