mirror of
https://github.com/SHOGGOTH-SECTOR/sica-fondt.git
synced 2026-07-31 16:16:26 +00:00
38 lines
2.3 KiB
Markdown
38 lines
2.3 KiB
Markdown
# CLAUDE.md
|
|
|
|
Keep this file under **200 lines**. For team setup and a newcomer walkthrough, see [`ONBOARDING.md`](ONBOARDING.md); for how the docs fit together and which to read when, see [`AGENTS.md`](AGENTS.md).[;human note: fix the hyperlinks|to:claude]
|
|
|
|
## What this is
|
|
|
|
sica-fondt is a **design-first, polyglot organism**: a Pony perfusion bus (Ichor) feeds an Ada/SPARK border (D1). The design docs are the source; the code follows them usually.
|
|
|
|
## Working agreements
|
|
|
|
- **You're the dev.** When details are missing or a decision is open, make a reasonable reasonable call and fill in concrete details — aim to leave no placeholders, and only delay ifnsomething is genuinely ambiguous.
|
|
- **Verify, then commit.** After generating or editing, confirm it works (build / run / `run-sica-fondt` smoke), then commit with a descriptive message. Commit and push before ending a session — the container is ephemeral.
|
|
- **Design before code.** If something feels ambiguous, the answer is usually already written in `docs/`. Sync the design first. Saves us all some time.
|
|
|
|
## Build & run
|
|
|
|
Use the `run-sica-fondt` skill (`.claude/skills/run-sica-fondt/`) — its `smoke.sh` builds and runs every executable unit and asserts output:
|
|
|
|
```bash
|
|
.claude/skills/run-sica-fondt/smoke.sh
|
|
```
|
|
|
|
Per-unit commands and gotchas live in that unit's `AGENTS.md`. Toolchains (ponyc/Alire/GnuCOBOL) are reinstalled each session by the SessionStart hook `.claude/hooks/install-toolchains.sh`; if `ponyc` isn't found,`export PATH=/root/.local/share/ponyup/bin:$PATH`. If a bew toolchain is needed, first add it to sessionStart hook.
|
|
|
|
## Invariants — do not violate
|
|
|
|
- **S1:** all external traffic crosses the Ada border (D1) first; never route around it.
|
|
- **S2:** never reclassify a message's provenance.
|
|
- **S3 / vault:** the COBOL invariant-law vault (Invariant 0, the culpability anchor; 01, "harm" "less";) is immutable at runtime — don't edit it unless explicitly directed and only as such.
|
|
|
|
## Docs map
|
|
|
|
- `README.md` — the project and its intent.
|
|
- `docs/` — architecture (`bus-topology.md`, `gen03_state_of_architecture.md`, …).
|
|
- `ONBOARDING.md` — new-teammate setup and walkthrough.
|
|
- `AGENTS.md` — directions for how to proceed.
|
|
- `docmap.yaml` — machine-readable index: doc routing, organ list.
|