Skip to content

Commit 74f6d1a

Browse files
authored
chore(issue-template): improve bug report template (#8673)
* chore(issue-template): improve bug report template * chore(issue-template): small fix to align text with logo * chore(issue-template): fix img not showing
1 parent e0bf7d0 commit 74f6d1a

File tree

2 files changed

+89
-29
lines changed

2 files changed

+89
-29
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 70 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,76 @@ body:
44
- type: markdown
55
attributes:
66
value: |
7-
Thank you for filing a bug report!
7+
<p align="center">
8+
<a href="https://zen-browser.app">
9+
<picture>
10+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/zen-browser/desktop/dev/docs/assets/zen-light.svg">
11+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/zen-browser/desktop/dev/docs/assets/zen-dark.svg">
12+
<img src="https://raw.githubusercontent.com/zen-browser/desktop/dev/docs/assets/zen-light.svg" alt="Zen Logo" width="64" height="64">
13+
</picture>
14+
<img src="https://raw.githubusercontent.com/zen-browser/desktop/dev/docs/assets/zen-browser.svg" alt="Zen Browser Text" width="156" height="64">
15+
</a>
16+
</p>
817
9-
## IMPORTANT READ
10-
- Please provide descriptive titles. Bad titles do more harm than good.
11-
- Please search existing issues to avoid creating duplicates.
12-
- For enhancement requests, please use GitHub Discussions.
13-
- Please fill out the template below to the best of your ability.
14-
- Please describe the issue as much as possible and provide steps to reproduce it along with visual aids if possible.
18+
<p align="center"><em>Thank you for filing a bug report!</em></p>
19+
20+
> [!IMPORTANT]
21+
> - Please provide descriptive titles. Bad titles do more harm than good.
22+
> - Please search existing issues to avoid creating duplicates.
23+
> - For enhancement requests, please use GitHub Discussions.
24+
> - Please fill out the template below to the best of your ability.
25+
> - Please describe the issue as much as possible and provide steps to reproduce it along with visual aids if possible.
1526
- type: checkboxes
1627
id: captchas
1728
attributes:
18-
label: Captchas
19-
description: Just making sure you did actually read the instructions.
29+
label: Preliminary Checks
30+
description: Please confirm the following before submitting a bug report. This helps us triage and resolve issues more efficiently.
2031
options:
21-
- label: I have read the instructions.
32+
- label: I have read and understood the important section above.
33+
required: true
2234
- label: I have searched existing issues and avoided creating duplicates.
35+
required: true
2336
- label: I am not filing an enhancement request.
37+
required: true
2438
- label: I have checked that this issue cannot be reproduced on Mozilla Firefox.
39+
required: true
2540
- label: I have checked that this issue can be reproduced once I removed all my Mods and Custom CSS.
26-
validations:
27-
required: true
41+
required: true
2842
- type: textarea
2943
id: what-happened
3044
attributes:
3145
label: What happened?
32-
description: Also tell us, what did you expect to happen?
46+
description: Describe the bug clearly and concisely.
3347
placeholder: Tell us what you see!
3448
validations:
3549
required: true
50+
- type: input
51+
id: expected-behavior
52+
attributes:
53+
label: Expected behavior
54+
description: Please write a description of what was supposed to happen.
55+
validations:
56+
required: true
57+
- type: input
58+
id: actual-behavior
59+
attributes:
60+
label: Actual behavior
61+
description: Please write a description of what actually happened.
62+
validations:
63+
required: true
64+
- type: textarea
65+
id: how-to-reproduce
66+
attributes:
67+
label: Steps to reproduce
68+
description: Please Provide numbered steps to reproduce this issue so developers can replicate them easily.
69+
validations:
70+
required: true
71+
- type: textarea
72+
id: screenshots
73+
attributes:
74+
label: Screenshots and videos
75+
description: |
76+
If applicable, add screenshots or videos to help explain your problem.
3677
- type: input
3778
id: version
3879
attributes:
@@ -52,8 +93,8 @@ body:
5293
- Linux (Tarball)
5394
- macOS - aarch64
5495
- macOS - Intel
55-
- Windows - x64
5696
- Windows - aarch64
97+
- Windows - x64
5798
- Other
5899
validations:
59100
required: true
@@ -63,26 +104,26 @@ body:
63104
label: What component is this issue related to?
64105
options:
65106
- Other
107+
- Bookmarks
66108
- Compact Mode
67-
- Workspaces
68-
- Mods / Themes
109+
- Customizable UI / Toolbars
110+
- Extensions
69111
- Glance
70-
- URL Bar
71-
- Tabs
72-
- Split View
73-
- Settings
74-
- Privacy
75-
- Performance
76-
- Media Controler
77-
- Tab unloading
78-
- Tab Folders
79112
- Keyboard Shortcuts
80-
- Security
81-
- Extensions
82-
- Customizable UI / Toolbars
83113
- Localization
84-
- Bookmarks
114+
- Media Controler
115+
- Mods / Themes
116+
- Performance
117+
- Privacy
118+
- Security
119+
- Settings
120+
- Split View
85121
- Sync
122+
- Tab Folders
123+
- Tab unloading
124+
- Tabs
125+
- URL Bar
126+
- Workspaces
86127
validations:
87128
required: true
88129

docs/assets/zen-browser.svg

Lines changed: 19 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)