idea152-hopemesh-federated-.../AGENTS.md

28 lines
1.1 KiB
Markdown

# HopeMesh AGENTS
- Overview
- A production-oriented skeleton for a cross-domain, offline-first resource allocation system with governance and adapters.
- Architecture
- Core primitives: LocalProblem, SharedSignals, PlanDelta (GoC-style contracts).
- Graph of Contracts (GoC): lightweight in-process graph to connect problems, signals, and actions.
- Adapters: pluggable endpoints for field units, warehouses, transport hubs; starter adapters included.
- Transport: TLS-backed channel abstraction for inter-device communication.
- Governance: skeleton ledger for provenance with per-message signatures (extensible to DID-based identities).
- Tech Stack
- Language: Python 3.9+
- Packaging: pyproject.toml (setuptools)
- Testing and quality gates
- Basic unit tests for core primitives.
- test.sh to run pytest and python -m build for packaging checks.
- AGENTS.md intentionally documents architecture so future agents can contribute without breaking it.
- How to run locally
- python3 -m pytest
- bash test.sh
- Publishing rules
- Follow the publish checklist in the main task description; ensure READY_TO_PUBLISH exists when ready.