mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-04-14 10:07:39 +08:00
github: simplify bug report issue template (#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
This commit is contained in:
parent
db2c6b2abe
commit
8e658a6e2d
105
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
105
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@ -3,92 +3,45 @@ description: Create a report to help us improve
|
|||||||
title: "[Bug] "
|
title: "[Bug] "
|
||||||
labels: ["bug-report"]
|
labels: ["bug-report"]
|
||||||
body:
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
**Tips for a great bug report:**
|
||||||
|
- Describe what went wrong and what you expected
|
||||||
|
- Include a flight log link from [logs.px4.io](http://logs.px4.io/) if possible
|
||||||
|
- Mention your PX4 version, flight controller, and vehicle type if relevant
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Describe the bug
|
label: Describe the bug
|
||||||
description: A clear and concise description of the bug.
|
description: A clear description of the bug and what you expected to happen.
|
||||||
|
placeholder: |
|
||||||
|
What happened and what did you expect instead?
|
||||||
|
|
||||||
|
Steps to reproduce (if applicable):
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: To Reproduce
|
label: Flight Log / Additional Information
|
||||||
description: |
|
description: |
|
||||||
Steps to reproduce the behavior.
|
**Flight log** (highly recommended for flight-related issues):
|
||||||
1. Drone switched on '...'
|
- Upload to [PX4 Flight Review](http://logs.px4.io/) and paste the link
|
||||||
2. Uploaded mission '....' (attach QGC mission file)
|
|
||||||
3. Took off '....'
|
|
||||||
4. See error
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
|
|
||||||
- type: textarea
|
**Additional details** (if relevant):
|
||||||
attributes:
|
- PX4 version (output of `ver all` in MAVLink Shell)
|
||||||
label: Expected behavior
|
- Flight controller model
|
||||||
description: A clear and concise description of what you expected to happen.
|
- Vehicle type (multicopter, fixed-wing, VTOL, etc.)
|
||||||
validations:
|
- Screenshots or media
|
||||||
required: false
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Screenshot / Media
|
|
||||||
description: Add screenshot / media if you have them
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Flight Log
|
|
||||||
description: |
|
|
||||||
*Always* provide a link to the flight log file:
|
|
||||||
- Download the flight log file from the vehicle ([tutorial](https://docs.px4.io/main/en/getting_started/flight_reporting.html)).
|
|
||||||
- Upload the log to the [PX4 Flight Review](http://logs.px4.io/)
|
|
||||||
- Share the link to the log (Copy and paste the URL of the log)
|
|
||||||
placeholder: |
|
placeholder: |
|
||||||
# PASTE HERE THE LINK TO THE LOG
|
Flight log link:
|
||||||
|
|
||||||
|
Version:
|
||||||
|
|
||||||
|
Hardware:
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
|
|
||||||
- type: markdown
|
|
||||||
attributes:
|
|
||||||
value: |
|
|
||||||
## Setup
|
|
||||||
|
|
||||||
- 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
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
|
|
||||||
- type: input
|
|
||||||
attributes:
|
|
||||||
label: Flight controller
|
|
||||||
description: Specify your flight controller model (what type is it, where was it bought from, ...).
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
|
|
||||||
- type: dropdown
|
|
||||||
attributes:
|
|
||||||
label: Vehicle type
|
|
||||||
options:
|
|
||||||
- Multicopter
|
|
||||||
- Helicopter
|
|
||||||
- Fixed Wing
|
|
||||||
- Hybrid VTOL
|
|
||||||
- Airship/Balloon
|
|
||||||
- Rover
|
|
||||||
- Boat
|
|
||||||
- Submarine
|
|
||||||
- Other
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: How are the different components wired up (including port information)
|
|
||||||
description: Details about how all is wired.
|
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Additional context
|
|
||||||
description: Add any other context about the problem here.
|
|
||||||
|
|||||||
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -1,4 +1,4 @@
|
|||||||
blank_issues_enabled: false
|
blank_issues_enabled: true
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: Support Question
|
- name: Support Question
|
||||||
url: https://docs.px4.io/main/en/contribute/support.html#forums-and-chat
|
url: https://docs.px4.io/main/en/contribute/support.html#forums-and-chat
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user