summaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE/bug_report.yml
blob: 4a6cdccb6ed4f34795f047a3f0cd41fe6fa99f3f (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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
name: Bug report
description: Found something wrong or broken? If it hasn't already been filed/solved, report it!
labels: ["bug"]
body:
  - type: checkboxes
    id: acknowledgements
    attributes:
      label: Checklist
      options:
        - label: >
            I've looked through [troubleshooting](https://clementtsang.github.io/bottom/nightly/troubleshooting),
            [known problems](https://clementtsang.github.io/bottom/nightly/support/official/#known-problems), and 
            [existing open issues](https://github.com/ClementTsang/bottom/issues?q=is%3Aopen+is%3Aissue) for similar
            issues.
          required: true

  - type: input
    id: operating_system
    attributes:
      label: What operating system and version are you using?
      description: >
        Please provide what operating system(s) and version(s) you are running that experiences the described issue.
        Note that operating systems that [are not officially supported](https://github.com/ClementTsang/bottom#support)
        may not be prioritized/resolved.
      placeholder: Arch Linux 5.18.15

  - type: dropdown
    id: architecture
    attributes:
      label: What architecture are you using?
      description: >
        Please select the architecture(s) that are experiencing the described issue.
        Note that systems that [are not officially supported](https://github.com/ClementTsang/bottom#support)
        may not be prioritized/resolved.
      multiple: true
      options:
        - x86_64 / AMD64
        - arm64
        - arm32
        - x86
        - Other (*please specify above in description*)

  - type: textarea
    id: terminal
    attributes:
      label: What terminal(s) are you running `bottom` on?
      description: >
        Please provide what terminal(s) you are running `bottom` on (e.g. Konsole, kitty)
        that are experiencing the issue, as well as their version and any relevant settings (e.g. terminal theme).
      placeholder: kitty 0.25.2

  - type: input
    id: version
    validations:
      required: true
    attributes:
      label: What version of `bottom` are you running?
      description: >
        Please provide which version of `bottom` you're running, which you can find with `btm -V`. If you are using
        a nightly/non-release version, please also specify that.
      placeholder: 0.9.0

  - type: input
    id: install
    validations:
      required: true
    attributes:
      label: How did you install `bottom`?
      description: >
        Please mention how you installed `bottom`. If you manually compiled it, please also mention your _Rust version_.

        **Note: if you installed from `bottom` from cargo, please ensure that you installed the right crate (https://crates.io/crates/bottom).**
      placeholder: Installed bottom through the Arch official repos.

  # TODO: After some point also add in a `btm check` invocation

  - type: textarea
    id: description
    validations:
      required: true
    attributes:
      label: Describe the issue
      description: >
        Give a description of the issue. If possible, provide screenshots/videos.
      placeholder: |
        Example:
        bottom is failing to output information for a mounted encrypted partition on basic mode. It should
        be able to report this information, but I'm not seeing the entry at all.

  - type: textarea
    id: expected
    validations:
      required: true
    attributes:
      label: What is the expected behaviour?
      description: >
        Describe the behaviour you expected.
      placeholder: |
        Example:
        I expect to be able to see information about the encrypted partition on basic mode.

  - type: textarea
    id: actual
    validations:
      required: true
    attributes:
      label: What is the actual behaviour?
      description: >
        Describe the behaviour you actually see. If possible, provide screenshots/videos.
      placeholder: |
        Example:
        I am unable to see information about my encrypted partition.

  - type: textarea
    id: reproduce
    validations:
      required: true
    attributes:
      label: How can we reproduce this?
      description: >
        Provide detailed steps on _how_ to reproduce your problem, to the best of your ability. Be as detailed as
        possible. Include any config files or flags used. If possible, provide screenshots/videos of the issue.

        Remember - if maintainers cannot reproduce the issue, it will be very hard to fix!
      placeholder: |
        Example:
          1. Mount a LUKS encrypted partition.
          2. Run `btm --basic`
          3. Observe there is no partition shown.

  - type: textarea
    id: additional
    attributes:
      label: Additional information
      description: Provide any additional information you think may be relevant or helpful.
      placeholder: It works fine if I just run it normally without the `--basic` flag.