Skip to content

Commit 290cccc

Browse files
chore(issue-template): enhance bug report template with additional fields and guidance (#4827)
* chore(issue-template): enhance bug report template with additional fields and guidance - Added a dropdown for reproducibility confirmation. - Improved descriptions and labels for clarity. - Updated installation options with links and support notes. - Included reverse proxy details for better issue context. * docs: update changelog
1 parent 1c8136f commit 290cccc

2 files changed

Lines changed: 40 additions & 7 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@ body:
77
attributes:
88
label: Is there an existing issue for this?
99
description: |
10+
Thank you for helping us make TeslaMate better, by reporting a bug you have found. This issue may already be reported.
1011
Please search to see if an issue already exists for the bug you encountered:
1112
1213
- [Issues](https://github.com/teslamate-org/teslamate/issues?q=)
1314
- [Discussions](https://github.com/teslamate-org/teslamate/discussions)
1415
1516
options:
16-
- label: I have searched the existing issues
17+
- label: I have checked the existing issues and discussions, and I can confirm that there are no duplicates.
1718
required: true
1819

1920
- type: markdown
@@ -37,10 +38,20 @@ body:
3738
validations:
3839
required: false
3940

41+
- type: dropdown
42+
id: can_repro
43+
attributes:
44+
label: Can the issue reliably be reproduced?
45+
options:
46+
- "Yes"
47+
- "No"
48+
validations:
49+
required: true
50+
4051
- type: textarea
4152
attributes:
42-
label: Steps To Reproduce
43-
description: Steps to reproduce the behavior.
53+
label: Steps To Reproduce the issue
54+
description: Explain how the maintainers can reproduce the issue.
4455
placeholder: |
4556
1. Go to '...'
4657
2. Click on '....'
@@ -108,8 +119,10 @@ body:
108119
attributes:
109120
label: Type of installation
110121
options:
111-
- Docker
112-
- Manual
122+
- Docker (https://docs.teslamate.org/docs/installation/docker/)
123+
- NixOS (https://docs.teslamate.org/docs/installation/nixos)
124+
- Manual (no support)
125+
- Other (no support)
113126
validations:
114127
required: true
115128

@@ -127,7 +140,7 @@ body:
127140
attributes:
128141
label: PostgreSQL version
129142
description: What version of PostgreSQL are you running? (see Database information dashboard -> PostgreSQL Version (upper right on desktop) or database -> image section in your `docker-compose.yml`)
130-
placeholder: v17
143+
placeholder: v17.3
131144

132145
- type: checkboxes
133146
attributes:
@@ -139,4 +152,23 @@ body:
139152
140153
options:
141154
- label: I run the latest major supported PostgreSQL version
142-
required: true
155+
validations:
156+
required: true
157+
158+
- type: dropdown
159+
id: reverse_proxy
160+
attributes:
161+
label: Are you using a reverse Proxy for TeslaMate?
162+
options:
163+
- "Yes (specify in next field)"
164+
- "No"
165+
validations:
166+
required: true
167+
168+
- type: textarea
169+
id: reverse_proxy_details
170+
attributes:
171+
label: Details about your reverse Proxy if applicable
172+
description: If you use a reverse Proxy, please provide details about your setup
173+
validations:
174+
required: true

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
- build(deps): bump timex from 3.7.11 to 3.7.13 (#4815)
4343
- build(deps): update flake.lock (#4828 - @JakobLichterfeld)
4444
- build(nix): update mix dependency hash in nix builds (#4828 - @JakobLichterfeld)
45+
- chore(issue-template): enhance bug report template with additional fields and guidance (#4827 - @JakobLichterfeld)
4546

4647
#### Dashboards
4748

0 commit comments

Comments
 (0)