rich/MeshTerm

0 Fork 0

Files

T

Jean-Pierre MartineauandClaude Sonnet 5 0ee350430d CONTRIBUTING: opening a PR is how you agree

New file laying out the ground rules for outside contributions ahead
of opening the repo up: dev setup, the test/lint gates a PR needs to
pass, and where the style guide lives (CLAUDE.md is that guide, not
just an AI aid).

The licensing section goes one step past what Apache-2.0's inbound
license clause alone gives — a PR also grants the right to relicense
the contribution later, so the project doesn't end up needing every
past contributor's sign-off if the license ever changes. Framed as
automatic (opening the PR is the agreement), no signature bot.

README's Development section now points to it.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

2026-08-12 03:03:43 -04:00

2.9 KiB

Raw Blame History

Contributing to MeshTerm

Thanks for wanting to work on MeshTerm. A few things to know before you open a pull request.

Licensing — what happens to your contribution

MeshTerm is licensed under the Apache License, Version 2.0. By opening a pull request, you agree to license your contribution under those same terms — and, going a step beyond what Apache-2.0 alone requires, you additionally grant Jean-Pierre Martineau (the project's copyright holder) the right to relicense your contribution as part of the MeshTerm project, should the project's license ever change in the future. You keep copyright over what you write; you're not signing it away, just granting these usage rights alongside it. No separate form, bot, or signature is needed — opening the PR is how you agree.

If that's not something you're comfortable granting, say so on the PR before it's merged and we'll talk about it, but by default that's the deal for anything merged into this repository.

Before you start

Read CLAUDE.md. It isn't just instructions for AI assistants — it's the actual style guide for this codebase: the terminology (node vs. contact, heard vs. seen, etc.), UX standards for screens/dialogs/menus, and where the reusable building blocks live in code (ui/menus.py, ui/markdown.py, ui/widgets.py, ui/theme.py). New code should read like it always belonged here.
For anything bigger than a small fix, open an issue first to talk it through before writing a lot of code — saves both of us a rewrite.

Making a change

Fork the repo and branch off main.
Set up a dev install:
```
pip install -e ".[dev]"
```

Before opening the PR, make sure these all pass:

python -m pytest -q       # tests, including tests/test_gallery.py — the dual-platform
                           # readability gate (screens must stay readable at 72 cols
                           # regular / 53 cols PicoCalc; every PicoCalc case is a hard gate)
ruff check .               # lint
ruff format --check .      # formatting

Keep commits focused; write imperative-mood messages and explain why when it isn't obvious from the diff.
Open the PR against main with a clear description of what changed and why.

Code style

Match the surrounding file: naming, comment density, idiom.
Follow the lexicon and UX standards in CLAUDE.md — one term per concept; don't introduce a synonym for something that already has a name.
New screens, dialogs, and rows go through the existing helpers rather than hand-rolled layout — CLAUDE.md names the enforcement points.

Reporting bugs / requesting features

Open a GitHub issue. For bugs, include what you expected, what happened, and enough to reproduce it — device/platform, MeshCore firmware version if relevant, and steps.

Questions about any of this, licensing included, are welcome as a GitHub issue or discussion before you put work in.

2.9 KiB Raw Blame History