deltatrace-deterministic-re.../AGENTS.md

1.0 KiB

DeltaTrace SWARM Guidelines

Architecture: production-grade MVP for end-to-end traceability, deterministic replay, and governance-ready audit trails in live market pipelines.

Stack: Python 3.9+, minimal dependencies. Production-oriented design with a clear separation between core replay logic and adapters.

Testing: use test.sh to run unit tests and packaging checks. Packaging should be validated with python3 -m build.

Contributions: small, focused changes with tests. Follow the project style and add docstrings.

Publishing: when ready, ensure pyproject.toml/build metadata is consistent and add READY_TO_PUBLISH.

Contributor Guide (Tip for MVP cycles)

  • Run test.sh to verify unit tests and packaging readiness after every meaningful change.
  • Use the provided tests as the contract for expected behavior (e.g., deterministic replay ordering and trace serialization).
  • Keep changes small and well-tested; prefer minimal, well-scoped edits over sweeping rewrites.
  • If adding new public APIs, document them in README and add tests that cover typical usage paths.