Simplify bug report issue template to reduce clutter #26191
Conversation
- 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
There was a problem hiding this comment.
Pull request overview
This PR simplifies the GitHub bug report issue template to make it less intimidating for users and reduce visual clutter from empty optional fields. The template is streamlined from 11 separate fields to just 2 main fields with helpful guidance.
Key changes:
- Consolidated 11 fields into 2 main textarea fields (bug description and flight log/additional info)
- Converted detailed instructions into a concise markdown tips section at the top
- Enabled blank issues to provide flexibility for edge cases
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .github/ISSUE_TEMPLATE/config.yml | Enables blank issues by changing blank_issues_enabled from false to true |
| .github/ISSUE_TEMPLATE/bug_report.yml | Restructures template from 11 fields to 2, combines optional fields into a single "Flight Log / Additional Information" section, and adds markdown tips at the top |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Flight log link: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Setup | ||
| Version: | ||
| - type: textarea | ||
| attributes: | ||
| label: Software Version | ||
| description: | | ||
| Which version of PX4 are you using? | ||
| placeholder: | | ||
| # If you don't know the version, paste the output of `ver all` in the MAVLink Shell of QGC | ||
| Hardware: |
There was a problem hiding this comment.
The placeholder content has inconsistent indentation compared to the earlier placeholder field. Lines 19-24 use 8 spaces of indentation for the placeholder content, while lines 41-45 use 10 spaces. For consistency and to follow YAML best practices, the indentation should be the same across both placeholder fields (8 spaces after the pipe character).
| **Flight log** (highly recommended for flight-related issues): | ||
| - Upload to [PX4 Flight Review](http://logs.px4.io/) and paste the link | ||
| **Additional details** (if relevant): | ||
| - PX4 version (output of `ver all` in MAVLink Shell) | ||
| - Flight controller model | ||
| - Vehicle type (multicopter, fixed-wing, VTOL, etc.) | ||
| - Screenshots or media |
There was a problem hiding this comment.
The indentation of the description content is inconsistent with the placeholder field. Lines 32-39 use 10 spaces of indentation for the description content, while line 17 (the description in the earlier field) doesn't use a multiline format. For consistency with the placeholder field above (lines 19-24 which use 8 spaces), consider using 8 spaces of indentation for the description content as well.
Summary
This simplifies the bug report issue template to reduce clutter in submitted issues.
Solved Problem
Currently, the bug report template has 11 separate fields, most of which are optional. When users submit issues without filling in optional fields, GitHub still displays empty sections, creating visual clutter and making issues harder to read. This discourages both issue reporters (intimidating long form) and maintainers (hard to parse cluttered issues).
Changes made: