Skip to content

Commit 60c06a8

Browse files
CarterLiCarterLi
committed
Doc: split bug report issue template into smaller parts [ci skip]
1 parent 8ceda02 commit 60c06a8

File tree

4 files changed

+333
-80
lines changed

4 files changed

+333
-80
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 80 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report_crash.yml‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
name: Crash Bug Report
2+
description: If fastfetch crashes or freezes
3+
title: "[BUG] "
4+
labels: ["bug", "crash", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report! We will try hard to solve the issue.
10+
However since platforms and hardwares vary greatly, it can be hard to find the root cause of an issue.
11+
Providing the following information may help us greatly. Thanks in advance!
12+
- type: checkboxes
13+
attributes:
14+
label: Read the FAQ first
15+
description: Please check if the issue is already covered in the FAQ.
16+
options:
17+
- label: I have checked the FAQ but the issue is not covered
18+
required: true
19+
- type: markdown
20+
attributes:
21+
value: "### General description of the bug"
22+
- type: textarea
23+
attributes:
24+
label: Description
25+
description: A clear and concise description of what the bug is.
26+
placeholder: I was trying to [...] but [...]
27+
validations:
28+
required: true
29+
- type: input
30+
attributes:
31+
label: Version used
32+
description: Fastfetch version used. Please use the latest version (found in the [releases](https://github.com/fastfetch-cli/fastfetch/releases)) if possible.
33+
placeholder: Result of `fastfetch --version`
34+
validations:
35+
required: true
36+
- type: dropdown
37+
attributes:
38+
label: Bug prevalence
39+
description: How often does the bug occur?
40+
options:
41+
-
42+
- Always
43+
- Sometimes
44+
- Rarely
45+
- Once
46+
- Other
47+
validations:
48+
required: true
49+
- type: dropdown
50+
attributes:
51+
label: Regression
52+
description: Did it work in an older version?
53+
options:
54+
-
55+
- Not sure
56+
- 'Yes'
57+
- 'No'
58+
validations:
59+
required: true
60+
- type: dropdown
61+
attributes:
62+
label: Installation
63+
description: Where did you install fastfetch from?
64+
options:
65+
-
66+
- GitHub Releases
67+
- GitHub Actions (nightly)
68+
- Built from source
69+
- Package manager
70+
validations:
71+
required: true
72+
- type: input
73+
attributes:
74+
label: Package manager
75+
description: Which package manager did you use if applicable?
76+
placeholder: e.g. `apt`, `pacman`, `brew`, `scoop`
77+
- type: markdown
78+
attributes:
79+
value: '### Often helpful information'
80+
- type: textarea
81+
attributes:
82+
label: Screenshots
83+
description: If applicable, add screenshots to help explain your problem.
84+
- type: textarea
85+
attributes:
86+
label: Configuration
87+
description: If applicable, paste your configuration file here.
88+
- type: textarea
89+
attributes:
90+
label: System information
91+
description: Output of `fastfetch -c all.jsonc --stat --format json`
92+
placeholder: |
93+
Note that this output will contain you public IP.
94+
If it is not relevant for the issue, feel free to remove it before uploading.
95+
- type: markdown
96+
attributes:
97+
value: |
98+
Paste the stacktrace here. You may get it with:
99+
100+
```shell
101+
# You may need Ctrl+C to stop the process if it freezes
102+
gdb -q -ex 'set confirm off' -ex run -ex 'bt full' -ex quit --args /path/to/fastfetch
103+
```
104+
105+
If you are able to identify which module crashed, the strace can be helpful too
106+
107+
```shell
108+
strace /path/to/fastfetch --multithreading false -s {MODULE} --pipe
109+
```
110+
111+
If you cannot do the instructions above, please upload the core dump file if available.
112+
- type: textarea
113+
attributes:
114+
label: Stacktrace
115+
description: Paste the stacktrace or core dump file here.
116+
validations:
117+
required: true

‎.github/ISSUE_TEMPLATE/bug_report_general.yml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: General Bug Report
2+
description: If something is not working as expected (wrong output, missing info, etc)
3+
title: "[BUG] "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report! We will try hard to solve the issue.
10+
However since platforms and hardwares vary greatly, it can be hard to find the root cause of an issue.
11+
Providing the following information may help us greatly. Thanks in advance!
12+
- type: checkboxes
13+
attributes:
14+
label: Read the FAQ first
15+
description: Please check if the issue is already covered in the FAQ.
16+
options:
17+
- label: I have checked the FAQ but the issue is not covered
18+
required: true
19+
- type: markdown
20+
attributes:
21+
value: "### General description of the bug"
22+
- type: textarea
23+
attributes:
24+
label: Description
25+
description: A clear and concise description of what the bug is.
26+
placeholder: I was trying to [...] but [...]
27+
validations:
28+
required: true
29+
- type: input
30+
attributes:
31+
label: Version used
32+
description: Fastfetch version used. Please use the latest version (found in the [releases](https://github.com/fastfetch-cli/fastfetch/releases)) if possible.
33+
placeholder: Result of `fastfetch --version`
34+
validations:
35+
required: true
36+
- type: dropdown
37+
attributes:
38+
label: Bug prevalence
39+
description: How often does the bug occur?
40+
options:
41+
-
42+
- Always
43+
- Sometimes
44+
- Rarely
45+
- Once
46+
- Other
47+
validations:
48+
required: true
49+
- type: dropdown
50+
attributes:
51+
label: Regression
52+
description: Did it work in an older version?
53+
options:
54+
-
55+
- Not sure
56+
- 'Yes'
57+
- 'No'
58+
validations:
59+
required: true
60+
- type: dropdown
61+
attributes:
62+
label: Installation
63+
description: Where did you install fastfetch from?
64+
options:
65+
-
66+
- GitHub Releases
67+
- GitHub Actions (nightly)
68+
- Built from source
69+
- Package manager
70+
validations:
71+
required: true
72+
- type: input
73+
attributes:
74+
label: Package manager
75+
description: Which package manager did you use if applicable?
76+
placeholder: e.g. `apt`, `pacman`, `brew`, `scoop`
77+
- type: markdown
78+
attributes:
79+
value: '### Often helpful information'
80+
- type: textarea
81+
attributes:
82+
label: Screenshots
83+
description: If applicable, add screenshots to help explain your problem.
84+
- type: textarea
85+
attributes:
86+
label: Configuration
87+
description: If applicable, paste your configuration file here.
88+
- type: textarea
89+
attributes:
90+
label: System information
91+
description: Output of `fastfetch -c all.jsonc --stat --format json`
92+
placeholder: |
93+
Note that this output will contain you public IP.
94+
If it is not relevant for the issue, feel free to remove it before uploading.
95+
validations:
96+
required: true

0 commit comments

Comments
 (0)