summary refs log tree commit diff
path: root/.github/ISSUE_TEMPLATE/bug_report.yaml
blob: 871189e759bedc54a85a23d4195fbe698a74995f (plain) (blame)
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
name: Bug Report
description: Create a report to help us improve
#title: "[Bug]: "
labels: [bug]
body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
        Please try to fill out all fields to the best of your ability.
  - type: textarea
    id: description
    attributes:
      label: Describe the bug
      description: A clear and concise description of what the bug is.
      placeholder: Enter your description here.
    validations:
      required: true
  - type: textarea
    id: reproduction-steps
    attributes:
      label: To Reproduce
      description: Steps to reproduce the behavior.
      placeholder: |
        1. Go to '...'
        2. Click on '....'
        3. Scroll down to '....'
        4. See error
      value: |
        1. Go to '...'
        2. Click on '....'
        3. Scroll down to '....'
        4. See error
    validations:
      required: true
  - type: textarea
    id: behaviour
    attributes:
      label: What happened?
      description: A clear and concise description of what actually happened.
    validations:
      required: false
  - type: textarea
    id: expected-behaviour
    attributes:
      label: Expected behavior
      description: A clear and concise description of what you expected to happen.
    validations:
      required: false
  - type: textarea
    id: screenshots
    attributes:
      label: Screenshots
      description: If applicable, add screenshots to help explain your problem.
      placeholder: Upload your screenshots here. You can paste them or click on "Attach files".
    validations:
      required: false
  - type: input
    id: version
    attributes:
      label: Version
      description: Get the version from the settings menu (bottom left corner)
      placeholder: 0.0.1-deafbeef
    validations:
      required: true
  - type: dropdown
    id: os
    attributes:
      label: Operating system
      multiple: true
      options:
        - Linux
        - macOS
        - Windows
        - BSD
        - Haiku
        - Other
  - type: dropdown
    id: install-method
    attributes:
      label: Installation method
      multiple: true
      options:
        - Flathub
        - Flatpak nightly repo or download
        - AppImage
        - Windows download
        - macOS DMG file
        - Some repository (AUR, homebrew, distribution repository, PPA, etc)
        - Local build
  - type: input
    id: qt-version
    attributes:
      label: Qt version
      description: What version of Qt does your system use? (If you compiled Nheko yourself.)
      placeholder: 5.15.2.
    validations:
      required: false
  - type: input
    id: compiler
    attributes:
      label: C++ compiler
      description: What compiler (and version) did you use (if you compiled Nheko yourself)?
      placeholder: gcc-9000
    validations:
      required: false
  - type: input
    id: de
    attributes:
      label: Desktop Environment
      description: If you are on Linux, describe your desktop environment.
      placeholder: KDE with i3 as the window manager
    validations:
      required: false
  - type: checkboxes
    id: profiles
    attributes:
      label: Did you use profiles?
      description: Usually by passing the --profile command line parameter. If you don't know, answer 'no'.
      options:
        - label: Profiles used?
          required: false
  - type: textarea
    id: logs
    attributes:
      label: Relevant log output
      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
      placeholder: |
        The log file is located in
          Linux: ~/.cache/nheko/
          macOS: ~/Library/Caches/nheko or /Library/Caches/nheko
          Windows: C:/Users/<USER>/AppData/Local/nheko/cache
      render: shell
  - type: textarea
    id: backtrace
    attributes:
      label: Backtrace
      description: If the program crashed send a backtrace.
      placeholder: |
        You can retrieve a backtrace by building nheko with -DCMAKE_BUILD_TYPE=Debug and running it through gdb or lldb.

        gdb ./build/nheko

        >> run

        ... Make the program crash

        >> bt
      render: shell