32 lines
1.5 KiB
Markdown
32 lines
1.5 KiB
Markdown
# OpenFederatedCompiler: Architecture and Contribution Guide
|
|
|
|
Overview
|
|
- A multi-agent, privacy-preserving policy compiler MVP intended to federate policy across edge devices.
|
|
- Core primitives: LocalPolicy, SharedVariables, PlanDelta, DualVariables, PrivacyBudget, AuditLog, PolicyBlock, Graph-of-Contracts.
|
|
- Delta-sync via CRDT-like merge to support offline islanding and deterministic replay on reconnect.
|
|
- Adapter registry (Graph-of-Contracts) to manage protocol contracts and compatibility.
|
|
|
|
Tech Stack (Python-based MVP)
|
|
- Language: Python 3.8+ for rapid prototyping and strong typing with dataclasses.
|
|
- Core modules: idea157_openfederatedcompiler_privacy_preserving (core library).
|
|
- Tests: pytest-based unit tests.
|
|
- Packaging: pyproject.toml with setuptools.
|
|
|
|
Testing and Commands
|
|
- Run unit tests: bash test.sh
|
|
- Build package: python3 -m build (requires build package)
|
|
- Lint: Not included yet; extend later with flake8/ruff if needed.
|
|
|
|
Repository Structure (high-level)
|
|
- pyproject.toml: Packaging metadata and build-system config.
|
|
- README.md: Project overview.
|
|
- AGENTS.md: This document.
|
|
- READY_TO_PUBLISH: Marker file once the MVP is complete and ready for publishing.
|
|
- idea157_openfederatedcompiler_privacy_preserving/: Core library package (Python).
|
|
- tests/: Test-suite root.
|
|
|
|
Contribution Rules
|
|
- Do not modify core architecture without signaling intent and updating tests.
|
|
- Keep changes minimal and well-scoped.
|
|
- Ensure tests pass before proposing further changes.
|