32 lines
1.4 KiB
Markdown
32 lines
1.4 KiB
Markdown
OpenCode: MarketMesh – Architecture, Tech Stack, Testing, and Contribution Rules
|
||
|
||
Overview
|
||
- A privacy-preserving federated benchmarking scaffold for startups. Adapters map device-specific metrics to canonical signals; data channels (morphisms) carry aggregated stats with privacy budgets.
|
||
|
||
Tech Stack
|
||
- Language: Python 3.8+
|
||
- Core concepts: Contracts, Local DP (optional), Secure Aggregation (simulated), Delta-Sync, Governance Ledger (audit logs), Adapter Registry.
|
||
- Adapters: Stripe revenue adapter, Shopify funnel adapter (minimum viable implementations).
|
||
|
||
Testing and Commands
|
||
- Run tests: ./test.sh
|
||
- Build packages: python3 -m build
|
||
- Linting (optional): pip install flake8; flake8 .
|
||
|
||
Repository Structure (high level)
|
||
- marketmesh_privacy_preserving_federated_: Core package
|
||
- marketmesh_privacy_preserving_federated_/adapters: Adapter implementations
|
||
- tests/: Unit tests
|
||
- test.sh: Test runner that executes tests and packaging build
|
||
|
||
Contribution Rules
|
||
- Complete, small, well-scoped changes with tests.
|
||
- Do not modify packaging metadata unless necessary; ensure tests remain green.
|
||
- Document changes with clear commit messages (why-focused).
|
||
|
||
Governance and Conventions
|
||
- All data is anonymized/aggregated; DP budgets are simulated for MVP.
|
||
- Logs and contracts are versioned; adapters must expose a conformance interface.
|
||
|
||
This document helps future agents contribute without breaking the repo.
|