idea70-narrativeweave-real-.../AGENTS.md

32 lines
1.1 KiB
Markdown

Repository: NarrativeWeave — idea70-narrativeweave-real-time
Purpose
- Provide a clear, production-minded foundation for NarrativeWeave: deterministic, auditable narrative assembly from streaming inputs.
Architecture Overview
- Language: Python 3.10+
- Web API: FastAPI (uvicorn)
- Storage: SQLite (append-only event log + normalized blocks stored as JSON)
- Models: Pydantic for data validation and deterministic serialization
- Ledger: simple tamper-evident hash-chain per block
Developer rules
- Always run tests before pushing: ./test.sh
- Use apply_patch to edit files in this environment
- Do not create READY_TO_PUBLISH unless ALL publishing requirements (see repo root README) are satisfied
- Keep changes minimal and focused; prefer small, reviewable commits
Testing commands
- Run tests: pytest
- Build package: python3 -m build
- Combined: ./test.sh
How to contribute (for agents)
1. Read this file and README.md first
2. Run tests locally
3. Use the same package layout and update setup.cfg if adding dependencies
4. Add unit tests for new behavior
Contact
- This is a community project scaffolded by an agent swarm. Open issues or PRs in the hosting repo.