From 3e71799b3014b1a5b2e845512738ee799606f28f Mon Sep 17 00:00:00 2001 From: Maximilian Seidler <78690852+PaideiaDilemma@users.noreply.github.com> Date: Wed, 24 Jul 2024 15:52:15 +0000 Subject: [PATCH] misc: add issue templates (#440) * misc: add issue templates Copied from Hyprland and slightly modified * misc: but template --version and minor improvements * misc: fix bug template closing tag --- .github/ISSUE_TEMPLATE/bug.yml | 104 +++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature.yml | 19 ++++++ 2 files changed, 123 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..cd2ec91 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,104 @@ +name: Bug Report +description: Something is not working right +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + ## Before opening a new issue, please take a moment to search through the current open and closed issues to check if it already exists. + + --- + + - type: dropdown + id: type + attributes: + label: Regression? + description: | + Regression means that something used to work but no longer does. + **BEFORE CONTINUING**, please check if this bug is a regression or not, and if it is, we need you to bisect with the help of the wiki: https://wiki.hyprland.org/Crashes-and-Bugs/#bisecting-an-issue + multiple: true + options: + - "Yes" + - "No" + validations: + required: true + + - type: textarea + id: ver + attributes: + label: Hyprlock Info and Version + description: | + Please enter your hyprlock version and config. + Use `hyprlock --version` if it is available (Introduced after v0.4.1). + + Otherwise please figure out the hyprlock version via your distribution. + If you built it yourself, post the commit hash. + + Provide your hyprlock config. Usually `~/.config/hypr/hyprlock.conf`. + value: " + +
+ Hyprlock config + + + ```sh + + + + ``` + + +
" + validations: + required: true + + - type: textarea + id: compositor + attributes: + label: Compositor Info and Version + description: | + If you are on hyprland, paste the output of `hyprctl systeminfo` here. + If you are on another compositor, enter the compositor name and version you are on. + value: "
+ System/Version info + + + ```sh + + + + ``` + + +
" + validations: + required: true + + - type: textarea + id: desc + attributes: + label: Description + description: "What went wrong?" + validations: + required: true + + - type: textarea + id: repro + attributes: + label: How to reproduce + description: "How can someone else reproduce the issue?" + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Crash reports, logs, images, videos + description: | + Anything that can help. Please always ATTACH and not paste them. + To get hyprlock logs, start it from the commandline. + If you are using hypridle/swayidle as a systemd service, you can use `journalctl -b0 --user -u hypridle/swayidle` to get some logs. + Compositor logs and crashes are sometimes relevant as well. + Hyprland logs can be found in $XDG_RUNTIME_DIR/hypr. + Hyprland crash reports are stored in ~/.cache/hyprland or $XDG_CACHE_HOME/hyprland. + diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..b34786a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,19 @@ +name: Feature Request +description: I'd like to request additional functionality +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Before opening a new issue, take a moment to search through the current open ones. + + --- + + - type: textarea + id: desc + attributes: + label: Description + description: "Describe your idea" + validations: + required: true +