idea34-openpassmarket-priva.../AGENTS.md

1.4 KiB

AGENTS: OpenPassMarket Core - Architecture & Contribution Guide

Overview

  • This repository hosts the core primitives for a privacy-preserving federated optimization marketplace prototype.
  • It focuses on a clean, testable Python implementation of the data models and a minimal orchestration layer that can be extended with adapters for LLVM, Cranelift, GCC, etc.

Tech Stack

  • Language: Python 3.8+
  • Packaging: pyproject.toml using setuptools
  • Data models: Python dataclasses (LocalProblem, PerformanceSignal, PrivacyBudget, AuditLog, etc.)
  • Registry: GraphOfContracts (in-memory registry for adapters and contract versions)
  • Tests: pytest

Testing & Running

  • To run tests: bash test.sh
  • Packaging build: python3 -m build

Repository Rules for Agents

  • Do not modify user-facing behavior abruptly; aim for small, well-scoped changes with clear tests.
  • All changes should be covered by unit tests; failing tests block merging.
  • Documentation: update AGENTS.md and README.md when introducing new modules or public APIs.
  • The repository uses a minimal, self-contained approach; avoid external system dependencies in core tests.

Contribution Workflow

  • Implement small, focused changes first (data models, simple utilities).
  • Add/extend tests to cover the new behavior.
  • Update README and AGENTS.md to reflect new APIs and usage.

Note

  • This is a seed for a larger ecosystem; subsequent iterations will add REST/IPC adapters, TLS transport, and a conformance/test harness.