The README, CONTRIBUTING, SECURITY, the docs index, the development documents, the script READMEs, the comments of config.example.toml and pyproject.toml, and the issue and pull request forms. The legal sections of the README (attribution and licence) stay exactly as they were, between ste: off and ste: on markers. The SignPath attribution line, the one-line description of MeshTerm, every code block, and every URL do not change. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
147 lines
5.2 KiB
YAML
147 lines
5.2 KiB
YAML
name: Bug report
|
|
description: Report a problem with MeshTerm
|
|
labels: [bug]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
We hope that you never need this form.
|
|
|
|
If you do need it, first run this command and attach the file that it writes.
|
|
|
|
```
|
|
meshterm diagnostics --out bug.md
|
|
```
|
|
|
|
The file says which MeshTerm you use, on which machine, in which terminal, and with
|
|
which radio, transport, and firmware. This is most of the information that I would
|
|
otherwise ask for in single questions. It is also the information that people most
|
|
often guess. The file has no private information: no keys, no pairing PINs, no
|
|
positions, and no contacts. A test checks this. It is not only a promise.
|
|
|
|
The **Diagnostics** page in the menu saves the same file next to the log. Press `s`,
|
|
or F3 on the PicoCalc.
|
|
|
|
The rest of this form asks only for the information that the file cannot know.
|
|
|
|
- type: textarea
|
|
id: problem
|
|
attributes:
|
|
label: What is the problem
|
|
description: What happens, and what you expected to happen.
|
|
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 can I make it happen
|
|
description: >
|
|
Write the steps in order. Start from the time that you start MeshTerm. Name the
|
|
screens and the keys. This is more useful than a description. For example,
|
|
"Contacts, Enter on a node, Routes tab, Enter on the second route" is better 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 complete app with a fake radio. If the bug also occurs with
|
|
`--mock`, the bug is in MeshTerm, and I can look for it without your hardware. If
|
|
the bug does not occur with `--mock`, it is in the link or in the radio. This is a
|
|
different search. This one question tells me which of the two jobs this is, so
|
|
please take the minute to answer it.
|
|
options:
|
|
- "Yes, still happens with --mock"
|
|
- "No, --mock is fine"
|
|
- "I have not tried it"
|
|
- "Does not apply: the problem is the connection"
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: diagnostics
|
|
attributes:
|
|
label: The diagnostics block
|
|
description: >
|
|
Drag `bug.md` into this field, or paste its contents here. If you cannot make the
|
|
file, because MeshTerm does not start at all, write the reason instead. Also write
|
|
your version. I will work with that information.
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: handheld
|
|
attributes:
|
|
label: Which handheld, if it is a handheld
|
|
description: >
|
|
Answer this only if you use a device that the diagnostics file cannot name. The file
|
|
can tell a PicoCalc from a regular terminal. But a uConsole and a laptop look almost
|
|
the same to it. Leave this blank on a desktop, a laptop, or a 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 the firmware from the radio itself. When
|
|
the problem is the connection, the file has nothing to read. In this one case, I
|
|
need you to tell me. Be exact. "A Xiao" can mean several boards that do not behave
|
|
in the same way.
|
|
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. Do not take a photograph of the screen. A search can find text, and
|
|
a photograph of a terminal is difficult to read. If MeshTerm crashed, paste the
|
|
complete traceback.
|
|
render: text
|
|
|
|
- type: textarea
|
|
id: log
|
|
attributes:
|
|
label: The log file
|
|
description: >
|
|
MeshTerm keeps a log at `~/.meshterm/meshterm.log` (or at the place that
|
|
`MESHTERM_HOME` points to). Attach the file, or paste the last twenty lines inside a
|
|
``` fence. If the problem is difficult to catch, set **Log detail** to Debug on the
|
|
Preferences page and restart MeshTerm. Then do the action one more time, and send
|
|
that log instead. It records much more information.
|
|
|
|
- type: textarea
|
|
id: workaround
|
|
attributes:
|
|
label: Is there a way around it
|
|
description: Write anything that avoids the problem or lets you continue. Tell us also when the way around is not good.
|
|
|
|
- type: textarea
|
|
id: extra
|
|
attributes:
|
|
label: Anything else
|
|
description: >
|
|
Did it work before? Did the problem start after an update? Screenshots of a screen
|
|
that looks wrong are very useful here. For errors, text is better.
|