The project can be joined, reported to, and argued with
The rest of the community files, which are the half of open-sourcing that is not code: how someone tells you about a hole, what happens if a thread turns nasty, and what you will be asked when they file a bug. SECURITY.md points at GitHub's private vulnerability reporting rather than an address that will be scraped, and promises only what one person in his spare time can keep — an acknowledgement inside a week, which is not a fix inside a week, and a decision inside ninety days. Its scope section is the MeshTerm-specific part: a channel key or an admin password reaching a log, an export or the screen is a vulnerability here, a crafted packet corrupting the observation database is one, and a hole in the MeshCore firmware or in `bleak` is somebody else's to fix. It also says plainly that the database is not encrypted, because a backup of it carries a mesh's whole history. The code of conduct is Contributor Covenant 2.1, taken verbatim from source rather than paraphrased, with a real address in the enforcement section. The bug form asks the seven things that otherwise get asked in every thread: version, flavour, transport, OS and Python, terminal and its size, companion firmware. Flavour is there because the PicoCalc draws itself in 53 columns and sixteen colours, so a layout bug in one flavour frequently does not exist in the other. It asks for the version from the splash screen rather than from `meshterm --version`, which does not exist yet. Dependabot is weekly and capped low, with minor and patch grouped into one pull request: a solo maintainer facing five dependency PRs every Monday stops reading any of them. Funding points at the three destinations the app's own support page already offers, so the two cannot drift. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
1 parent
117b958edf
commit
628b665420
9 files changed
+331
No files matched your search
@@ -0,0 +1,6 @@
|
||||
# Kept in step with meshterm/assets/pages/support.md deliberately. If the app offers a
|
||||
# way to chip in and this file doesn't, the two have drifted and one of them is lying.
|
||||
buy_me_a_coffee: johnputer
|
||||
custom:
|
||||
- "https://www.patreon.com/c/MeshTerm"
|
||||
- "https://tinyurl.com/SupportMeshTerm"
|
||||
@@ -0,0 +1,99 @@
|
||||
name: Bug report
|
||||
description: Something MeshTerm does wrong, and how to see it happen
|
||||
labels: [bug]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
The fields below are the ones that get asked in every single bug thread, so
|
||||
answering them up front usually saves a day of back-and-forth.
|
||||
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened
|
||||
description: What you saw, and what you expected instead.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: repro
|
||||
attributes:
|
||||
label: How to see it happen
|
||||
description: >
|
||||
The screens and keys, in order. "Contacts, Enter on a node, Routes tab, Enter on
|
||||
the second route" beats "open a trace".
|
||||
placeholder: |
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: MeshTerm version
|
||||
description: Shown on the splash screen and on the About page.
|
||||
placeholder: "0.2.0"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: platform
|
||||
attributes:
|
||||
label: Which flavour
|
||||
description: >
|
||||
MeshTerm draws itself differently on a PicoCalc — 53 columns, sixteen colours, a
|
||||
different font. A bug in one flavour often does not exist in the other.
|
||||
options:
|
||||
- Regular (desktop or ssh)
|
||||
- PicoCalc
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: transport
|
||||
attributes:
|
||||
label: How the companion is connected
|
||||
options:
|
||||
- USB / serial
|
||||
- Bluetooth
|
||||
- TCP
|
||||
- No companion (simulator / --mock)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: os
|
||||
attributes:
|
||||
label: Operating system and Python version
|
||||
placeholder: "Windows 11, Python 3.12"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: terminal
|
||||
attributes:
|
||||
label: Terminal, and its size in columns x rows
|
||||
description: >
|
||||
Layout bugs are usually terminal bugs. Which terminal, and how big, decides
|
||||
whether anyone can reproduce what you are seeing.
|
||||
placeholder: "Windows Terminal, 120x40"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: firmware
|
||||
attributes:
|
||||
label: Companion device and firmware version
|
||||
description: Leave blank if no radio was involved.
|
||||
placeholder: "Heltec V3, MeshCore 1.15.0"
|
||||
|
||||
- type: textarea
|
||||
id: extra
|
||||
attributes:
|
||||
label: Anything else
|
||||
description: >
|
||||
A screenshot of the screen, the traceback if it crashed, or what the radio was
|
||||
doing at the time. Paste text rather than a photo of text where you can.
|
||||
@@ -0,0 +1,7 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Questions, setup help, and general mesh chat
|
||||
url: https://discord.gg/AZwe5Uvb3S
|
||||
about: >
|
||||
Not sure whether it's a bug? Ask on Discord first — it's faster, and someone
|
||||
running the same radio has probably hit it.
|
||||
@@ -0,0 +1,30 @@
|
||||
name: Feature request
|
||||
description: Something MeshTerm should be able to do
|
||||
labels: [enhancement]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
MeshTerm is one person's spare time, so the honest answer to a good idea is often
|
||||
"yes, eventually". Saying what you are actually trying to do — rather than the
|
||||
feature you have in mind — often finds something that already works.
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: What are you trying to do
|
||||
description: The situation you are in, not the feature. What are you trying to find out about your mesh?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: idea
|
||||
attributes:
|
||||
label: What you had in mind
|
||||
description: If you have a shape in mind — a screen, a key, a subcommand — describe it.
|
||||
|
||||
- type: textarea
|
||||
id: today
|
||||
attributes:
|
||||
label: What you do today instead
|
||||
description: The workaround, if there is one. This says more about how much the feature is worth than anything else.
|
||||
@@ -0,0 +1,16 @@
|
||||
## What this changes, and why
|
||||
|
||||
<!-- The why matters more than the what — the diff already says the what. -->
|
||||
|
||||
## Related issue
|
||||
|
||||
<!-- CONTRIBUTING asks for an issue first on anything non-trivial, so a large PR with no
|
||||
issue behind it will get a conversation before it gets a review. Link it here. -->
|
||||
|
||||
## Before you mark it ready
|
||||
|
||||
- [ ] `python -m pytest -q` passes, including the dual-platform gallery gate
|
||||
- [ ] `ruff check .` and `ruff format --check .` are clean
|
||||
- [ ] New screens, rows and hints go through the helpers in `ui/menus.py`, and follow the
|
||||
lexicon and UX standards in `CLAUDE.md`
|
||||
- [ ] Anything user-visible has a line in `CHANGELOG.md` under `[Unreleased]`
|
||||
@@ -0,0 +1,26 @@
|
||||
# Weekly, and small on purpose. A solo maintainer reviewing five open dependency PRs
|
||||
# every Monday stops reviewing them at all, so the caps are low enough to stay readable.
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: pip
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
day: monday
|
||||
open-pull-requests-limit: 5
|
||||
groups:
|
||||
# One PR for the routine noise; anything major still arrives on its own so it
|
||||
# gets read on its own.
|
||||
minor-and-patch:
|
||||
update-types: [minor, patch]
|
||||
commit-message:
|
||||
prefix: deps
|
||||
|
||||
- package-ecosystem: github-actions
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
day: monday
|
||||
open-pull-requests-limit: 3
|
||||
commit-message:
|
||||
prefix: ci
|
||||
Reference in new issue
Block a user