aboutsummaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/bug_report.yml
blob: 734ab55b8459f77ba3b2245035e9415cc3d04e57 (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
name: Bug Report
description: Create a report to help us improve.
labels: [bug]
body:
  - type: checkboxes
    id: terms
    attributes:
      label: Welcome
      options:
        - label: Yes, I'm using the latest major release or the current development version. These are the only supported versions.
          required: true
        - label: Yes, I've searched similar issues and discussions on GitHub and didn't find any.
          required: true

  - type: textarea
    id: current
    attributes:
      label: Current Behavior
      placeholder: |-
        Describe the current behavior,
        e.g., »When pressing Alt+j (focus left), the window above the current window is focused.«
    validations:
      required: true

  - type: textarea
    id: expected
    attributes:
      label: Expected Behavior
      placeholder: |-
        Describe the desired behavior you expect after mitigation of the issue,
        e.g., »The window left next to the current window should be focused.«
    validations:
      required: true

  - type: textarea
    id: reproduction
    attributes:
      label: Reproduction Instructions
      placeholder: |-
        Please provide detailed instructions on how the bug can be reproduced.
        E.g., »Open three windows in a V[A H[B C]] layout on a new workspace«
    validations:
      required: true

  - type: textarea
    id: version
    attributes:
      label: i3 version
      description: |-
        Paste the output of
        ```
        i3 --moreversion 2>&-
        ```
      render: text
    validations:
      required: true

  - type: textarea
    id: config
    attributes:
      label: Config file
      description: |-
        Please include your (complete) i3 config with which the issue occurs.

        If you would like to help debugging the issue, please try to reduce the config such that it is as close to the default config as possible while still reproducing the issue. This can help us bisect the root cause.
      render: text
    validations:
      required: true

  - type: input
    id: distro
    attributes:
      label: Linux distribution & Version
    validations:
      required: true

  - type: dropdown
    id: compositor
    attributes:
      label: Are you using a compositor?
      description: |-
        Try running
        ```shell
        pidof picom
        pidof compton
        ```
        If any IDs show up, you are running a compositor
      options:
        - I don't know
        - I am sure I don't run any compositor
        - picom
        - compton
        - Other
    validations:
      required: true

  - type: input
    id: verbose-output
    attributes:
      label: Logfile
      description: |-
        Providing the URL to a logfile can help us trace the root cause of an issue much quicker. You can learn how to generate the logfile here:
        https://i3wm.org/docs/debugging.html

        Providing the logfile is optional.
    validations:
      required: false