summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/bug.yml
blob: 5a20b8907865f56635c07aaf6e62b7a61a766d87 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
name: Bug Report
description: Something is not working right
labels: ["bug"]
body:
  - type: checkboxes
    attributes:
      label: Already reported ? *
      description: Before opening a new bug report, please take a moment to search through the current open issues. If the same bug is already reported, don't open new issue - instead go upvote/comment on an existing one.
      options:
        - label: I have searched the existing open and closed issues.
          required: true

  - 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:
        - "Definitely a regression - something broke after update (requires bisect)"
        - "Probably not a regression / I don't remember it happening before"
        - "Not a regression - it's bug regarding new feature"
        - "Not a regression - it's an old bug"
        - "I don't know, I started using Hyprland only recently"
    validations:
      required: true

  - type: textarea
    id: ver
    attributes:
      label: System Info and Hyprland Version
      description: |
        Paste the output of `hyprctl systeminfo` here. If you can't
        launch Hyprland, paste the output of `Hyprland --systeminfo`.
      value: "<details>
        <summary>System/Version info</summary>


        ```

        <Paste the output of the command here, without removing any formatting around this>

        ```


        </details>"
    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?"
      placeholder: |
        1. ...
        2. ...
        3. ...

    validations:
      required: true

  - type: markdown
    attributes:
      value: |
        ## Additional info section

        In the section below you will be asked to upload some files.

        When including text files (such as logs or config), please **always ATTACH** them, and not paste them directly.

        This is important to avoid clutter, spam, and make the issues more readable.
        Thanks for your understanding.

  # The main reason to disallow pasting directly or in a dropdown, is to not clutter
  # the issue with unnecessary keywords, making the github issue search useless.
  - type: checkboxes
    attributes:
      label: Attach not paste
      options:
        - label: I understand that all text files must be *attached*, and not pasted directly. If not respected, this issue will likely get closed as spam
          required: true

  - type: markdown
    attributes:
      value: >-
        Please be sure to upload the following files below if they are relevant to the issue:

          - Logs can be found in $XDG_RUNTIME_DIR/hypr (sort by date to grab the latest)
          - Crash reports are stored in ~/.cache/hyprland or $XDG_CACHE_HOME/hyprland
          - Hyprland config files - `hyprctl systeminfo -c > /tmp/hyprland_config_dump.txt` use this command to dump full configuration to a single file.

  - type: checkboxes
    attributes:
      label: Checklist of files to include below
      options:
        - label: Hyprland config - `hyprctl systeminfo -c` (always include)
        - label: Crash report (always include in case of crash)
        - label: Video (always include in case of a visual bug)
        - label: Logs (might contain useful info such as errors)

  - type: textarea
    id: logs
    attributes:
      label: Additional info & File uploads
      description: |
        Tip: You can attach files by clicking this area to highlight it and then dragging files in.