Skip to content

Commit fa73c19

Browse files
committed
docs: add bug and feature request templates
1 parent c52ec96 commit fa73c19

File tree

2 files changed

+145
-0
lines changed

2 files changed

+145
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
name: Bug Report
2+
description: You think something is broken
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
> The title of the bug report should be short and descriptive.
11+
> Use relevant keywords for searchability.
12+
> Do not leave it blank, but also do not put an entire error log in it.
13+
- type: checkboxes
14+
attributes:
15+
label: Checklist
16+
description: |
17+
Please perform basic debugging to see if your configuration is the cause of the issue.
18+
Basic debug procedure
19+
 1. Update - sometimes things just need to be updated
20+
 2. Backup and revert your .env adjustments - check if the issue is caused by bad configuration
21+
 3. Try a fresh installation in a different directory - see if a clean installation solves the issue
22+
Before making a issue report please, check that the issue hasn't been reported recently.
23+
options:
24+
- label: The issue exists on a clean installation
25+
- label: The issue exists in the current version
26+
- label: The issue has not been reported before
27+
- label: The issue has been reported before but has not been fixed yet
28+
- type: markdown
29+
attributes:
30+
value: |
31+
> Please fill this form with as much information as possible. Don't forget to add information about "Which OS" and provide screenshots if possible
32+
- type: textarea
33+
id: what-did
34+
attributes:
35+
label: What happened?
36+
description: Tell us what happened in a very clear and simple way
37+
placeholder: |
38+
application crashes on bootup.
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: steps
43+
attributes:
44+
label: Steps to reproduce the problem
45+
description: Please provide us with precise step by step instructions on how to reproduce the bug
46+
placeholder: |
47+
1. Go to ...
48+
2. Press ...
49+
3. ...
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: what-should
54+
attributes:
55+
label: What should have happened?
56+
description: Tell us what you think the normal behavior should be
57+
placeholder: |
58+
It should have ...
59+
validations:
60+
required: true
61+
- type: dropdown
62+
id: browsers
63+
attributes:
64+
label: What browsers do you use to access the dashboard?
65+
multiple: true
66+
options:
67+
- Mozilla Firefox
68+
- Google Chrome
69+
- Brave
70+
- Apple Safari
71+
- Microsoft Edge
72+
- Android
73+
- iOS
74+
- Other
75+
- type: dropdown
76+
id: hosting
77+
attributes:
78+
label: Where are you running the app?
79+
multiple: false
80+
options:
81+
- Locally
82+
- Locally with virtualization (e.g. Docker)
83+
- Cloud (e.g. AWS, GCP, Azure)
84+
- type: input
85+
id: operating-system
86+
attributes:
87+
label: What operating system are you using?
88+
placeholder: |
89+
Windows 11 / MacOS 15.3.2
90+
- type: textarea
91+
id: logs
92+
attributes:
93+
label: Console logs
94+
description: Please provide **full** cmd/terminal logs from the moment you started UI to the end of it, after the bug occurred. If it's very long, provide a link to pastebin or similar service.
95+
render: Shell
96+
validations:
97+
required: true
98+
- type: textarea
99+
id: misc
100+
attributes:
101+
label: Additional information
102+
description: |
103+
Please provide us with any relevant additional info or context.
104+
Examples:
105+
 I have updated packages recently.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
title: "[Feature Request]: "
4+
labels: ["enhancement", "triage"]
5+
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the feature you want, and that it's not implemented in a recent build/commit.
11+
options:
12+
- label: I have searched the existing issues and checked the recent builds/commits
13+
required: true
14+
- type: markdown
15+
attributes:
16+
value: |
17+
*Please fill this form with as much information as possible, provide screenshots and/or illustrations of the feature if possible*
18+
- type: textarea
19+
id: feature
20+
attributes:
21+
label: What would your feature do?
22+
description: Tell us about your feature in a very clear and simple way, and what problem it would solve
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: workflow
27+
attributes:
28+
label: Proposed workflow
29+
description: Please provide us with step by step information on how you'd like the feature to be accessed and used
30+
value: |
31+
1. Go to ....
32+
2. Press ....
33+
3. ...
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: misc
38+
attributes:
39+
label: Additional information
40+
description: Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)