Files
lilygo-t-deck/AGENTS.md
T
Dejvino c80fcc609b Add pre-commit test gate + AGENTS.md
- .githooks/pre-commit: runs 'make netdeck-test-unit' (fast layer:
  unit + integration) before every commit; bypass with --no-verify
- make hooks: enables the hook for a clone (core.hooksPath .githooks)
- AGENTS.md: toolchain, one-command build/test entry points, hook
  install instructions, commit discipline
2026-11-14 15:07:47 +01:00

35 lines
1.3 KiB
Markdown

# T-Deck workspace — agent notes
## Toolchain
- platformio `pio` is in `~/.platformio/` (`~/.platformio/penv/bin/pio`), or
on `PATH` if available.
## Build & test — one command each, from the repo root
- `make netdeck` — builds BOTH targets of the app: ESP32-S3 firmware
(pio) and SDL2 emulator. Both must stay green.
- `make netdeck-test` — full headless test suite: unit + integration
(fast, deterministic) + E2E journeys (separate build, ~1-2 min).
- `make netdeck-test-unit` — fast layer only (unit + integration, seconds).
- `emulator/tests/README.md` — how the test layers work and how to add
tests (unit/integration headers, E2E journeys).
## Git hooks
A pre-commit hook runs the fast test layer (`make netdeck-test-unit`)
before every commit. Hooks are not versioned inside `.git/hooks`; this
repo ships them under `.githooks/`. Enable with:
make hooks # = git config core.hooksPath .githooks
- Bypass once with `git commit --no-verify` (use sparingly, say why).
- Disable: `git config --unset core.hooksPath`.
## Commit discipline
- Feature/increment commits: `make netdeck` (dual build) + the relevant
test layer must pass before committing.
- Milestone commits: run `make netdeck-test` (full suite) and update
`src/netdeck/STATUS.md` in the same commit.