Extension Guide

Extension Guide

The easiest way to contribute is to add one small module behind an existing interface.

Good First Extensions

• A new CSV-compatible data adapter.
• A simple analyst that emits standard Signal objects.
• A risk gate that clips or blocks decisions under a new constraint.
• An execution simulator variant.
• A new evaluator that reads a completed Trajectory.
• A small visual demo under examples/.

Recommended Path

Start with:

python examples/extension_walkthrough_demo.py

This demo swaps in:

• GapVolumeAnalyst
• VolatilityCircuitBreakerRisk
• ExtensionCoverageEvaluator

The rest of the stack stays fixed: data provider, strategy, execution simulator, memory, reproducibility state, trajectory logger, and report generation.

Contribution Checklist

• Keep the module narrow and testable.
• Add a small example script when the behavior is user-facing.
• Add or update tests if the module changes core behavior.
• Do not commit raw model prompt/response caches or credentials.
• Keep live API use optional.