Skip to content

docs: add AGENTS.md with plugin perf rules#30

Open
msallin wants to merge 1 commit intoSignalK:masterfrom
msallin:docs/agents-md
Open

docs: add AGENTS.md with plugin perf rules#30
msallin wants to merge 1 commit intoSignalK:masterfrom
msallin:docs/agents-md

Conversation

@msallin
Copy link
Copy Markdown
Contributor

@msallin msallin commented Apr 29, 2026

Adapt the AGENTS.md pattern from `SignalK/signalk-server` to this plugin's context: hot path is per-`navigation.position` tick at 1-2 Hz on Pi 3-5, the worker boundary structured-clones `srcPaths` every tick, and there are now caches keyed on a main-thread version counter that documents need to call out.

Covers code-quality principles, the per-tick hot path file list, allocation rules, the benchmarking workflow (`npm run bench` + #24's harness), commit conventions, and PR guidelines. No code changes.

@msallin msallin mentioned this pull request Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant