summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/bug_report.yaml
blob: 3f53bbe52d79929b9d0b5f95168c0e109506903b (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
name: Bug report
description: Create a bug report
labels: ["bug"]

body:
  - type: markdown
    attributes:
      value: |
        Before submitting a bug, please check that it has not already been reported by searching in [open and closed bugs](https://github.com/weechat/weechat/issues?q=is%3Aissue+label%3Abug).
        If you don't use the latest version, please try if possible with the latest stable release to be sure the issue is still present and report the issue on this version.

        **IMPORTANT**: please do not report any security issue here, see [Contributing.adoc](https://github.com/weechat/weechat/blob/master/Contributing.adoc#security-reports).

  - type: textarea
    id: bug-description
    attributes:
      label: Describe the bug
      description: A clear and concise description of what the bug is.
    validations:
      required: true

  - type: textarea
    id: steps-to-reproduce
    attributes:
      label: Steps to reproduce
      description: |
        Steps to reproduce the issue.
        If possible, please try to reproduce with a default configuration and no scripts loaded (`weechat -t`). If the issue is related to a script, please mention the list of all scripts loaded.
      placeholder: |

        1.
        2.
        3.
    validations:
      required: true

  - type: textarea
    id: current-behavior
    attributes:
      label: Current behavior
      description: |
        What currently happens.
    validations:
      required: true

  - type: textarea
    id: expected-behavior
    attributes:
      label: Expected behavior
      description: What is actually supposed to happen.
    validations:
      required: true

  - type: textarea
    id: suggested-solutions
    attributes:
      label: Suggested solutions
      description: How you think this issue can be resolved.
    validations:
      required: false

  - type: textarea
    id: additional-information
    attributes:
      label: Additional information
      description: |
        For a crash, please include a backtrace from gdb, see the [User's guide](https://weechat.org/doc/weechat/user/#report_crashes).
        For a display issue, please add a screenshot if it makes sense.
        Please mention if other versions are affected as well and if some versions are not affected (regression?).
        And any additional information you deem relevant.
    validations:
      required: false

  - type: input
    id: weechat-version
    attributes:
      label: WeeChat version
      description: |
        For a stable release: output of `weechat --version`.
        For the development version: output of command `/v` in WeeChat.
      placeholder: "4.1.1"
    validations:
      required: true

  - type: input
    id: os-version
    attributes:
      label: What OS are you using?
      description: Name of the operating system and its version.
      placeholder: Debian 12, Ubuntu 23.10, MacOS 14, ...
    validations:
      required: true

  - type: input
    id: terminal
    attributes:
      label: On which terminal are you running WeeChat?
      description: The name of terminal if you think it can be related to the issue (mainly for display issues).
      placeholder: Terminator, Xterm, GNOME Terminal, Urxvt, ...
    validations:
      required: false

  - type: input
    id: terminal-multiplexer
    attributes:
      label: Which terminal multiplexer are you using?
      description: The name of the terminal multiplexer if you think it can be related to the issue (mainly for display issues).
      placeholder: none, tmux, screen, ...
    validations:
      required: false