diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index d135e46fc..6639407eb 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,20 +1,22 @@ # Meshtastic Firmware - Copilot Instructions > **TL;DR** -> | | | -> |---|---| -> | Local tests | `./bin/run-tests.sh` (exit 0 GREEN · 1 RED · 2 AMBER · 3 FILTERED) | -> | Hardware tests | `./mcp-server/run-tests.sh` | -> | Format | `trunk fmt` | -> | Mirror docs | `AGENTS.md` (short pointer for agents that don't read this file) · `CLAUDE.md` (Claude Code) | +> +> | | | +> | -------------- | -------------------------------------------------------------------------------------------- | +> | Local tests | `./bin/run-tests.sh` (exit 0 GREEN · 1 RED · 2 AMBER · 3 FILTERED) | +> | Hardware tests | `./mcp-server/run-tests.sh` | +> | Format | `trunk fmt` | +> | Mirror docs | `AGENTS.md` (short pointer for agents that don't read this file) · `CLAUDE.md` (Claude Code) | > > **Need this? It's here.** -> | | | -> |---|---| -> | General helpers (clamp, UTF-8, string fmt…) | `src/meshUtils.h` | -> | Logging macros (LOG_DEBUG / INFO / WARN…) | `src/DebugConfiguration.h` | -> | New module skeleton | inherit `ProtobufModule` in `src/mesh/ProtobufModule.h` | -> | Observer / event wiring | `src/Observer.h` | +> +> | | | +> | ------------------------------------------- | ---------------------------------------------------------- | +> | General helpers (clamp, UTF-8, string fmt…) | `src/meshUtils.h` | +> | Logging macros (LOG_DEBUG / INFO / WARN…) | `src/DebugConfiguration.h` | +> | New module skeleton | inherit `ProtobufModule` in `src/mesh/ProtobufModule.h` | +> | Observer / event wiring | `src/Observer.h` | This document provides context and guidelines for AI assistants working with the Meshtastic firmware codebase. diff --git a/AGENTS.md b/AGENTS.md index 2124f65f4..0a0c82406 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,20 +1,22 @@ # Agent instructions > **TL;DR** -> | | | -> |---|---| -> | Local tests | `./bin/run-tests.sh` (exit 0 GREEN · 1 RED · 2 AMBER · 3 FILTERED) | -> | Hardware tests | `./mcp-server/run-tests.sh` | -> | Format | `trunk fmt` | -> | Mirror docs | `.github/copilot-instructions.md` (canonical) · `CLAUDE.md` (Claude Code) | +> +> | | | +> | -------------- | ------------------------------------------------------------------------- | +> | Local tests | `./bin/run-tests.sh` (exit 0 GREEN · 1 RED · 2 AMBER · 3 FILTERED) | +> | Hardware tests | `./mcp-server/run-tests.sh` | +> | Format | `trunk fmt` | +> | Mirror docs | `.github/copilot-instructions.md` (canonical) · `CLAUDE.md` (Claude Code) | > > **Need this? It's here.** -> | | | -> |---|---| -> | General helpers (clamp, UTF-8, string fmt…) | `src/meshUtils.h` | -> | Logging macros (LOG_DEBUG / INFO / WARN…) | `src/DebugConfiguration.h` | -> | New module skeleton | inherit `ProtobufModule` in `src/mesh/ProtobufModule.h` | -> | Observer / event wiring | `src/Observer.h` | +> +> | | | +> | ------------------------------------------- | ---------------------------------------------------------- | +> | General helpers (clamp, UTF-8, string fmt…) | `src/meshUtils.h` | +> | Logging macros (LOG_DEBUG / INFO / WARN…) | `src/DebugConfiguration.h` | +> | New module skeleton | inherit `ProtobufModule` in `src/mesh/ProtobufModule.h` | +> | Observer / event wiring | `src/Observer.h` | This repository is the [Meshtastic](https://meshtastic.org) firmware — a C++17 embedded codebase targeting ESP32 / nRF52 / RP2040 / STM32WL / Linux-Portduino LoRa mesh radios — plus a Python MCP server in `mcp-server/` that AI agents use to flash, configure, and test connected devices. diff --git a/CLAUDE.md b/CLAUDE.md index 3b24bf807..f4cac6e16 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,20 +1,22 @@ # Claude Code instructions > **TL;DR** -> | | | -> |---|---| -> | Local tests | `./bin/run-tests.sh` (exit 0 GREEN · 1 RED · 2 AMBER · 3 FILTERED) | -> | Hardware tests | `./mcp-server/run-tests.sh` | -> | Format | `trunk fmt` | -> | Mirror docs | `.github/copilot-instructions.md` (canonical) · `AGENTS.md` | +> +> | | | +> | -------------- | ------------------------------------------------------------------ | +> | Local tests | `./bin/run-tests.sh` (exit 0 GREEN · 1 RED · 2 AMBER · 3 FILTERED) | +> | Hardware tests | `./mcp-server/run-tests.sh` | +> | Format | `trunk fmt` | +> | Mirror docs | `.github/copilot-instructions.md` (canonical) · `AGENTS.md` | > > **Need this? It's here.** -> | | | -> |---|---| -> | General helpers (clamp, UTF-8, string fmt…) | `src/meshUtils.h` | -> | Logging macros (LOG_DEBUG / INFO / WARN…) | `src/DebugConfiguration.h` | -> | New module skeleton | inherit `ProtobufModule` in `src/mesh/ProtobufModule.h` | -> | Observer / event wiring | `src/Observer.h` | +> +> | | | +> | ------------------------------------------- | ---------------------------------------------------------- | +> | General helpers (clamp, UTF-8, string fmt…) | `src/meshUtils.h` | +> | Logging macros (LOG_DEBUG / INFO / WARN…) | `src/DebugConfiguration.h` | +> | New module skeleton | inherit `ProtobufModule` in `src/mesh/ProtobufModule.h` | +> | Observer / event wiring | `src/Observer.h` | **Read `.github/copilot-instructions.md` first.** That file is the canonical agent-facing document for this repo. It covers project layout, coding conventions, the build system, CI/CD, the native C++ test suite, and the MCP Server & Hardware Test Harness. Read it top-to-bottom before starting any non-trivial change.