1.4 KiB
1.4 KiB
Architecture and Contribution Guide for AI Agents
Purpose This repository contains Phase0 primitives for SoundGraph Studio: content-addressed audio modules, patch graphs with Merkle roots, and provenance events. It's intentionally small and well-tested so subsequent agents can expand to delta-sync, DAW adapters, and a governance ledger.
Tech stack
- Language: Python 3.8+
- Crypto: cryptography (ed25519 signatures)
- Testing: pytest
- Packaging: setuptools/pyproject.toml
Repository layout
- pyproject.toml - build metadata and dependencies
- setup.cfg - setuptools configuration
- README.md - user-facing documentation
- AGENTS.md - this file
- test.sh - run tests and build
- idea44_soundgraph_studio_verifiable/ - Python package code
- tests/ - pytest tests
Agent rules
- Always run the test suite after changes:
./test.sh. - Avoid making broad refactors unless requested; prefer small, well-scoped patches.
- When adding dependencies, update pyproject.toml and setup.cfg accordingly.
- Do NOT create
READY_TO_PUBLISHunless the repository fully implements the original idea and all tests pass (the orchestrator enforces this). - If you need to run commands, use the provided tooling and keep changes minimal.
Development notes
- The package name must remain
idea44_soundgraph_studio_verifiable. - Packaging must build successfully with
python3 -m build. - Tests must be present and passing; any added functionality should include at least one test.