Scaffold Lumbridge architecture and research plan

2026-08-31 14:37:49 -07:00
commit 8971ddcf58
19 changed files with 840 additions and 0 deletions
@@ -0,0 +1,44 @@
+# AGENTS.md
+
+These rules apply to the entire Lumbridge repository.
+
+## Product boundary
+
+Lumbridge is a terminal/workspace runtime and ACP client. It may host, supervise,
+and observe coding harnesses, but must not silently impersonate them, scrape their
+private credentials, or claim provider quota data that cannot be verified.
+
+## Research boundary
+
+Upstream repositories are cloned outside this Git repository under the desktop
+workspace's `Research/` directory. They are references, not vendored code.
+
+- Do not copy upstream implementation code without an explicit license review.
+- Record the source repository and relevant license for any adapted design.
+- AGPL/GPL and unlicensed repositories may be studied for behavior and UX only
+  unless the project deliberately changes its licensing strategy.
+
+## Engineering rules
+
+- Keep provider, harness, protocol, terminal, persistence, and UI boundaries
+  separate. A provider is not a harness and ACP is not a provider API.
+- Preserve a PTY fallback. ACP adds structure but must not be required to open a
+  normal shell or run an arbitrary CLI.
+- Keep secrets out of SQLite, logs, crash reports, command-line arguments, and
+  repository files. Store only opaque secret references in application state.
+- Usage values must include a provenance and confidence classification.
+- Avoid platform behavior hidden behind scattered `cfg` blocks; isolate it in
+  platform adapters with shared contract tests.
+- No telemetry is enabled by default. Any future telemetry must be documented,
+  opt-in, redacted, and independently disableable.
+
+## Verification
+
+Before committing Rust changes, run:
+
+```bash
+cargo fmt --all --check
+cargo clippy --workspace --all-targets --all-features -- -D warnings
+cargo test --workspace --all-features
+```
+