rich/MeshTerm
1
0 Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

The project can be joined, reported to, and argued with

Browse Source 
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:
Jean-Pierre MartineauandClaude Opus 5 committed 2026-09-07 04:31:32 -04:00
1 parent 117b958edf
commit 628b665420
9 files changed
+331
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

.github/FUNDING.yml
+6
View File
@@ -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"
.github/ISSUE_TEMPLATE/bug.yml
+99
View File
@@ -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.
.github/ISSUE_TEMPLATE/config.yml
+7
View File
@@ -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.
.github/ISSUE_TEMPLATE/feature.yml
+30
View File
@@ -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.
.github/PULL_REQUEST_TEMPLATE.md
+16
View File
@@ -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]`
.github/dependabot.yml
+26
View File
@@ -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
CHANGELOG.md
+2
View File
@@ -24,6 +24,8 @@ allowed to change behaviour, not just add to it.
from outside the source tree.
- A release workflow with no automatic trigger, which publishes nothing until a human runs
it on purpose and types the version.
- A security policy, a code of conduct, issue and pull request templates, weekly
dependency updates, and the funding links the app's own support page already offers.
## [0.2.0] — 2026-09-07
CODE_OF_CONDUCT.md
+83
View File
@@ -0,0 +1,83 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at johnputer@meshterm.net. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of actions.
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
SECURITY.md
+62
View File
@@ -0,0 +1,62 @@
# Security policy
## Reporting a vulnerability
Use GitHub's private vulnerability reporting: go to the **Security** tab of this
repository and choose **Report a vulnerability**. That opens a private thread visible only
to you and the maintainer, so nothing is disclosed while it is being fixed.
If that is unavailable to you for any reason, email <johnputer@meshterm.net> instead.
**Please do not open a public issue for a security problem.**
## What to expect
MeshTerm is maintained by one person in his spare time, so this promises only what can
actually be kept:
- **An acknowledgement within a week.** Not a fix within a week — an answer saying the
report was read and what happens next.
- **A fix or a decision within 90 days** for anything confirmed. If it will take longer,
you will be told why.
- **Credit in the release notes**, unless you would rather not be named.
A slow reply is not a dismissal. If a week passes with silence, a nudge on the same thread
is welcome.
## Supported versions
While the major version is `0`, only the **latest release** is supported. There are no
backports; a fix ships in the next version.
## Scope
In scope — anything in this repository:
- Code execution, path traversal, or file overwrite triggered by data MeshTerm reads:
packets overheard from the mesh, a companion's responses, a config or preferences file,
a downloaded map tile.
- Anything that discloses a **channel key**, a **repeater admin password**, or a node's
private key material — including into the local database, a log, an export, or the
screen when it should not be there.
- Anything that lets a crafted packet corrupt or delete the observation database.
- Weaknesses in how MeshTerm stores credentials on disk.
Out of scope, though still worth telling us about somewhere:
- Vulnerabilities in the **MeshCore firmware** or in the companion device itself. Those
belong upstream at the MeshCore project.
- Vulnerabilities in the `meshcore` Python library, `bleak`, or any other dependency —
report those to their maintainers. If a MeshTerm change can mitigate one, we want to
know.
- The fact that anyone within radio range can hear a public channel. That is how a mesh
works, not a defect.
- Anything requiring an attacker to already have write access to your filesystem or your
companion device.
## A note on what MeshTerm handles
MeshTerm decrypts channel traffic using keys **you** give it, and it records everything it
overhears to a local SQLite database. That database is not encrypted. Treat it as you would
any file holding your mesh's history, and remember that a backup of it carries the same
weight.