Watch
1
0
Fork
You've already forked souveraine
0

docs: the working agreement for this repo

Points at the personal agreement and the cross-repo map, names this tree
as the substrate rather than a harness, and starts architecture at
saf/INDEX.md.
This commit is contained in:
Fimeg 2026-08-09 19:30:56 -04:00
commit abdf31087d

40
AGENTS.md Normal file
View file

@ -0,0 +1,40 @@
# Souveraine working agreement
The personal agreement is `~/.codex/AGENTS.md`. The cross-repo map is
`../AGENTS.md`; read it when work crosses repository boundaries.
## This repository
- This is the Rust agent substrate and Souveraine shell code. Use
**substrate**, not harness, unless quoting an external source.
- Start architecture at `saf/INDEX.md`. SAF is deliberately compact and still
being human-reviewed; when SAF and implementation disagree, code shows what
exists and both may need reconciliation.
- Work/status documentation for the wider OS belongs in
`../SouveraineOS/docs/tasks/` and `../SouveraineOS/STATE.md`, not a new local
handoff. Update the one owner when behavior moves.
- The normal branch is `primary`. Verify status and recent history before
editing, preserve unrelated changes, and stage explicit paths.
## Build and delivery
- Gitea Actions is the reproducible build/test/package path. Push the scoped
change and let CI build it.
- Keep local checks small and targeted. Do not replace the pipeline with a
direct ArchDev build, an offline build, or a hand-copied artifact.
- Runner access is diagnostic. A green result matters only if the relevant job
ran and, when required, published the expected package.
- Phone delivery is through package ownership and pacman. A symlink or copied
file on glass may prove behavior, but it is not landed.
## Shape of changes
- Preserve the substrate's one-owner instincts: one event path, one state
writer, one canonical memory/history operation, one shipping path.
- Commit subjects are terse and honest: change and reason. Terse does not mean
sterile in our first-party forge; a body may have teeth if it still serves
the change. No AI attribution or `Co-Authored-By` line.
- Separate verified behavior from reasoned design and from work never exercised
on hardware.
- Before calling cross-repo work complete, reconcile the owning SouveraineOS
task/state document and archive the task if its acceptance is actually met.