Skip to content

Commit f094643

Browse files
committed
Add more structure to the templates
1 parent 42afdc6 commit f094643

File tree

2 files changed

+34
-8
lines changed

2 files changed

+34
-8
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,27 @@ title: "[Firmware version] Bug title"
55
labels: bug
66
assignees: ""
77
---
8-
Please describe the steps to reproduce the bug.
9-
Sometimes, the best way is to record a short video and/or attach the project and provide links.
10-
Both need to be on external service (please use the one that does not delete files after short time).
11-
12-
Additional questions to answer:
13-
Does this bug happen every time or just once?
14-
Does this bug happen in previous firmware versions?
15-
Does this bug happen in every project?
8+
## Hi, sorry you had trouble!
9+
10+
### Steps to reproduce
11+
12+
Please describe the steps to reproduce the bug. Tell us what you noticed
13+
happening and what you expected to happen instead.
14+
15+
### Attachments and links
16+
17+
Often the best way to show the problem is to record a short video,
18+
attach the Tracker project you were working on, and provide links.
19+
20+
Pro-tip: You can drag and drop images and `.zip` files directly to the edit
21+
box when writing your bug reports. Videos are too big as attachments, you
22+
will have to use an external service for this and provide us links. Please
23+
don't use services that delete files after short periods of time.
24+
25+
### Other important information
26+
27+
* How often does this bug happen? (every time, often, "it only happened once")
28+
29+
* Does this bug happen in previous firmware versions?
30+
31+
* Does this bug happen in every project?

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,13 @@ title: ""
55
labels: enhancement
66
assignees: ""
77
---
8+
## Hi, we're excited to hear your idea!
9+
10+
Before you start, did you check whether your feature was already requested?
11+
Searching might save you quite a bit of time here.
12+
13+
### A new feature
14+
15+
Please tell us about your feature in as much detail as you can provide.
16+
Vague ideas are less likely to be successful. Concrete requests are
17+
easier to estimate.

0 commit comments

Comments
 (0)