Skip to content

ORIENT.md

Latest commit

 

History

History
55 lines (45 loc) · 3.34 KB

ORIENT.md

File metadata and controls

55 lines (45 loc) · 3.34 KB
Raw

Agent orientation

Open this when the task area is unclear. Facts stay in the owner files in README.md. This page only routes. Open the one row that matches the change. Leave the other owners closed.

Crate graph

For workspace crate roles, see CRATES.md. Crate-specific read-first links are in crates/<name>/AGENTS.md when present. Those files own no facts.

Before the first edit in a crate, read crates/<name>/AGENTS.md when that file exists.

Read first

Task Read
Confirm stage IO, leftover union, pin identity, silent fallback invariants.md
Writer roles, publish order, body queue, pins concurrency.md
On-disk bytes, schema bump / migrate / refuse ../SCHEMA.md
Process RAM, body-queue caps, production evict ibd-memory.md
io_uring vs fd; do not flatten a purpose-built machine io-modality.md
Which head file (tx / header / scripthash) heads.md
Crash, tip-as-commit, kill-9 crash-recovery.md
Tests, budgets, coverage, fixtures ../TESTING.md
A missed cargo-mutants case ../TESTING.md (Mutation testing). The miss list is missed.txt on the mutants-state branch
Multi-step plan (Red → Green → Refactor) how-we-plan.md (stop before Rationale)
cargo / clippy / deny / rustc logs (do not load into the session) how-we-plan.md (Agent RAM)
rearden-grok[bot] operator VM (ignore unless that identity) ../rearden-vm-HOST.md
Intentional Core / Electrum / Esplora differences ../COMPAT.md
JSON-RPC surface rpc.md
Which wallet or Lightning node connects wallets.md, lightning.md
Open, push, or poll a PR ../.agents/skills/ship-pr/SKILL.md (one worktree; fail-fast pr-checks-watch.sh)
Minor, patch, or major release ../.agents/skills/release/SKILL.md
Core functional harness ../.agents/skills/core-functional/SKILL.md
Overlay functional harness (private Tor / i2pd / cjdns) ../.agents/skills/overlay-functional/SKILL.md
Warnet two-tank example (label warnet) core-functional.md (Warnet lab)

Ask first

Hard stops in ../AGENTS.md are proceed-or-stop rules. rearden-grok[bot] also follows ../rearden-vm-HOST.md; other identities ignore that file.

Ask before any of these, including when the change looks locally justified:

  • Replace a purpose-built IO machine with batched pread / pwrite.
  • Bump or wipe the schema, or add an RBITCOIN_* knob.
  • Widen who is trusted beyond ../SECURITY.md.
  • Merge, force-push master, or cargo clean the shared cargo silo.
  • Start an item in quality.md or peer-clients.md that the user did not name.
  • Open a mainnet datadir, or treat an agent-VM run as a perf result.
  • Label an ordinary net or RPC pull request core-functional.