Make examples more regularized and focused, and add contribution guidelines for the examples folder#928
Merged
Conversation
…elines for the examples folder
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #928 +/- ##
=======================================
Coverage 62.41% 62.41%
=======================================
Files 25 25
Lines 4497 4497
=======================================
Hits 2807 2807
Misses 1690 1690
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
jeremiah-k
added a commit
to jeremiah-k/mtjk
that referenced
this pull request
Jun 1, 2026
…htastic#928 Ports the 6 new files from upstream master 81ae8b6 (PR meshtastic#928 by ianmcorvidae): - examples/CONTRIBUTING.md - examples/tcp_connection_info_once.py - examples/tcp_pubsub_send_and_receive.py (replacement for pub_sub_example*.py) - examples/meshtastic_serial_message_reader.py - examples/textchat.py - examples/replymessage.py The rewrites of existing example files in 81ae8b6 (get_hw.py, hello_world_serial.py, info_example.py, scan_for_devices.py, set_owner.py, show_ports.py, tcp_gps_example.py, waypoint.py) are skipped because develop's versions are already more robust (context managers, type hints, stricter error handling) than master's modernization. Upstream commit: 81ae8b6 (Make examples more regularized and focused) Original author: Ian McEwen <ian@ianmcorvidae.net>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Includes the example from #739 as part of this.
This should mean a little less anything-goes in the examples folder, hopefully. Probably still more we could do to make that nice, but this is an okay start.