Every list of three or more takes the serial comma: the one-liner in
pyproject.toml, meshterm/__init__.py, and --help ("USB, Bluetooth, or TCP",
"Windows, macOS, and Linux"), the README, the changelog, the manuals, the
issue and PR templates, and six strings the app shows (the region-name
rule, a repeater setting's help, the diagnostics tool's description, and
the archive confirms). The Windows-console notice is rewrapped so its
comma keeps it inside 72 columns.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
144 lines
4.9 KiB
YAML
144 lines
4.9 KiB
YAML
name: Bug report
|
|
description: Report a problem with MeshTerm
|
|
labels: [bug]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Hopefully you never need this form.
|
|
|
|
If you do: start by running this, and attach the file it writes.
|
|
|
|
```
|
|
meshterm diagnostics --out bug.md
|
|
```
|
|
|
|
It answers which MeshTerm, on which machine, in which terminal, talking to which
|
|
radio over which transport and firmware — most of what I would otherwise ask one
|
|
question at a time, and the details people most often end up guessing at. Nothing
|
|
in it is private: no keys, no pairing PINs, no positions, no contacts. That is a
|
|
tested property, not a promise.
|
|
|
|
The **Diagnostics** page in the menu saves the same file (with `s`, or F3 on the
|
|
PicoCalc), next to the log.
|
|
|
|
The rest of this form asks only for what that file cannot know.
|
|
|
|
- type: textarea
|
|
id: problem
|
|
attributes:
|
|
label: What's the problem
|
|
description: What happens, and what you expected to happen instead.
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: how-often
|
|
attributes:
|
|
label: How often does it happen
|
|
options:
|
|
- Every single time
|
|
- Often, but not always
|
|
- Now and then, no pattern I can see
|
|
- Once, and I haven't seen it since
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: repro
|
|
attributes:
|
|
label: How do I make it happen
|
|
description: >
|
|
The steps, in order, starting from launching MeshTerm. Screens and keys beat
|
|
descriptions — "Contacts, Enter on a node, Routes tab, Enter on the second route"
|
|
is worth more than "open a trace".
|
|
placeholder: |
|
|
1.
|
|
2.
|
|
3.
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: mock
|
|
attributes:
|
|
label: Does it still happen with `meshterm --mock`
|
|
description: >
|
|
`--mock` runs the whole app against a fake radio. If the bug survives that, it is
|
|
in MeshTerm and I can chase it without owning your hardware. If it doesn't, it is
|
|
in the link or the radio, which is a different hunt. This one question decides
|
|
which of those two jobs this is, so it is worth the minute it takes.
|
|
options:
|
|
- "Yes, still happens with --mock"
|
|
- "No, --mock is fine"
|
|
- "Haven't tried"
|
|
- "Doesn't apply — the problem is connecting"
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: diagnostics
|
|
attributes:
|
|
label: The diagnostics block
|
|
description: >
|
|
Attach `bug.md` by dragging it in, or paste its contents here. If you genuinely
|
|
cannot produce one, because MeshTerm will not start at all, write down why instead,
|
|
along with your version, and I will work with that.
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: handheld
|
|
attributes:
|
|
label: Which handheld, if it is a handheld
|
|
description: >
|
|
Only if you are running on something the diagnostics file cannot name. It knows a
|
|
PicoCalc from a regular terminal, but a uConsole and a laptop look much the same to
|
|
it. Leave blank on a desktop, laptop, or Mac.
|
|
placeholder: "ClockworkPi uConsole (CM4)"
|
|
|
|
- type: input
|
|
id: radio
|
|
attributes:
|
|
label: Which radio and firmware, if MeshTerm could not reach it
|
|
description: >
|
|
The diagnostics file reads the model and firmware off the radio itself, so when the
|
|
problem *is* connecting, it has nothing to read. That is the one case where I need
|
|
you to tell me. Be precise — "a Xiao" covers several boards that do not behave
|
|
alike.
|
|
placeholder: "Seeed XIAO nRF52840 + Wio-SX1262, MeshCore 1.15.0"
|
|
|
|
- type: textarea
|
|
id: error
|
|
attributes:
|
|
label: The exact error, if there was one
|
|
description: >
|
|
Copy it as text rather than photographing the screen — text can be searched, and a
|
|
photo of a terminal is hard to read. Paste the whole traceback if it crashed.
|
|
render: text
|
|
|
|
- type: textarea
|
|
id: log
|
|
attributes:
|
|
label: The log file
|
|
description: >
|
|
MeshTerm keeps one at `~/.meshterm/meshterm.log` (or wherever `MESHTERM_HOME`
|
|
points). Attach the file, or paste the last twenty lines inside a ``` fence. If the
|
|
problem is hard to catch, set **Log detail** to Debug on the Preferences page,
|
|
restart MeshTerm, do it once more, and send that instead. It records a great deal
|
|
more.
|
|
|
|
- type: textarea
|
|
id: workaround
|
|
attributes:
|
|
label: Is there a way around it
|
|
description: Anything that avoids it, or gets you unstuck. Say so even if it's ugly.
|
|
|
|
- type: textarea
|
|
id: extra
|
|
attributes:
|
|
label: Anything else
|
|
description: >
|
|
Did it used to work? Did it start after an update? Screenshots of a wrong-looking
|
|
screen are genuinely useful here, even though text is better for errors.
|