Documentation
Onboarding
Getting Started
Power & Battery
Hardware & Components
Build & Assembly
Radio & RF Design
Frequencies & Regulations
Firmware & Software
USB & Connectivity
GPS & Navigation
Morse & Communication
Modes & Operation
Field Operations & Rescue
Building Effectively
Build Variants
Project & Reference
Docs Project & Reference Reporting Issues

Reporting Issues

Edit on GitHub

Filing a useful bug report: the information a maintainer needs, the format, and what makes a report actionable.

Reporting Issues

A good bug report is a gift: it contains everything needed to reproduce, and nothing else. This page is the template the project asks for.

The template

CODE
title: one sentence, the symptom
Firmware version: (from the boot log or changelog)
Hardware: board, radio module, GPS module
Scenario: what you were doing
Expected: what should have happened
Actual: what happened instead
Serial log: the relevant lines

What makes a report actionable

IncludeExample
The version“v5.5.0”
The exact scenario“In CONFIG mode, setting TX power to +22, then saving”
The serial logThe lines around the failure (see Serial Monitor Guide)
A photo of the wiringFor hardware reports
What you already triedSaves the maintainer repeating your work

What makes it useless

  • “It doesn’t work” with no version, scenario or log
  • A photo of a screen with no explanation
  • Reporting two unrelated problems in one issue
  • Speculation about the cause instead of the facts

The verification step

Before filing, check the Troubleshooting page and the FAQ: the answer may already exist. A report that arrives after the user checked the wiki is worth double.