Skip to content

Commit e52bd5e

Browse files
farhangnaderiLuka Dragar
authored andcommitted
github: simplify bug report issue template (PX4#26191)
* Simplify bug report issue template to reduce clutter - Reduced from 11 fields to 2 consolidated fields - Enabled blank issues for flexibility - Combined optional fields into single "Flight Log / Additional Information" section - Added helpful tips at top instead of separate required fields - Eliminates empty field clutter in submitted issues while maintaining guidance * Fix inconsistent YAML indentation in bug report template
1 parent 1df997e commit e52bd5e

File tree

2 files changed

+28
-75
lines changed

2 files changed

+28
-75
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 27 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -3,92 +3,45 @@ description: Create a report to help us improve
33
title: "[Bug] "
44
labels: ["bug-report"]
55
body:
6-
- type: textarea
6+
- type: markdown
77
attributes:
8-
label: Describe the bug
9-
description: A clear and concise description of the bug.
10-
validations:
11-
required: true
8+
value: |
9+
**Tips for a great bug report:**
10+
- Describe what went wrong and what you expected
11+
- Include a flight log link from [logs.px4.io](http://logs.px4.io/) if possible
12+
- Mention your PX4 version, flight controller, and vehicle type if relevant
1213
1314
- type: textarea
1415
attributes:
15-
label: To Reproduce
16-
description: |
17-
Steps to reproduce the behavior.
18-
1. Drone switched on '...'
19-
2. Uploaded mission '....' (attach QGC mission file)
20-
3. Took off '....'
21-
4. See error
22-
validations:
23-
required: false
16+
label: Describe the bug
17+
description: A clear description of the bug and what you expected to happen.
18+
placeholder: |
19+
What happened and what did you expect instead?
2420
25-
- type: textarea
26-
attributes:
27-
label: Expected behavior
28-
description: A clear and concise description of what you expected to happen.
21+
Steps to reproduce (if applicable):
22+
1.
23+
2.
24+
3.
2925
validations:
30-
required: false
31-
32-
- type: textarea
33-
attributes:
34-
label: Screenshot / Media
35-
description: Add screenshot / media if you have them
26+
required: true
3627

3728
- type: textarea
3829
attributes:
39-
label: Flight Log
30+
label: Flight Log / Additional Information
4031
description: |
41-
*Always* provide a link to the flight log file:
42-
- Download the flight log file from the vehicle ([tutorial](https://docs.px4.io/main/en/getting_started/flight_reporting.html)).
43-
- Upload the log to the [PX4 Flight Review](http://logs.px4.io/)
44-
- Share the link to the log (Copy and paste the URL of the log)
32+
**Flight log** (highly recommended for flight-related issues):
33+
- Upload to [PX4 Flight Review](http://logs.px4.io/) and paste the link
34+
35+
**Additional details** (if relevant):
36+
- PX4 version (output of `ver all` in MAVLink Shell)
37+
- Flight controller model
38+
- Vehicle type (multicopter, fixed-wing, VTOL, etc.)
39+
- Screenshots or media
4540
placeholder: |
46-
# PASTE HERE THE LINK TO THE LOG
47-
validations:
48-
required: false
41+
Flight log link:
4942
50-
- type: markdown
51-
attributes:
52-
value: |
53-
## Setup
43+
Version:
5444
55-
- type: textarea
56-
attributes:
57-
label: Software Version
58-
description: |
59-
Which version of PX4 are you using?
60-
placeholder: |
61-
# If you don't know the version, paste the output of `ver all` in the MAVLink Shell of QGC
45+
Hardware:
6246
validations:
6347
required: false
64-
65-
- type: input
66-
attributes:
67-
label: Flight controller
68-
description: Specify your flight controller model (what type is it, where was it bought from, ...).
69-
validations:
70-
required: false
71-
72-
- type: dropdown
73-
attributes:
74-
label: Vehicle type
75-
options:
76-
- Multicopter
77-
- Helicopter
78-
- Fixed Wing
79-
- Hybrid VTOL
80-
- Airship/Balloon
81-
- Rover
82-
- Boat
83-
- Submarine
84-
- Other
85-
86-
- type: textarea
87-
attributes:
88-
label: How are the different components wired up (including port information)
89-
description: Details about how all is wired.
90-
91-
- type: textarea
92-
attributes:
93-
label: Additional context
94-
description: Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
blank_issues_enabled: false
1+
blank_issues_enabled: true
22
contact_links:
33
- name: Support Question
44
url: https://docs.px4.io/main/en/contribute/support.html#forums-and-chat

0 commit comments

Comments
 (0)