# Contributing to 太公心易 (Taigong Xinyi)

We welcome contributions from the community! Whether you're fixing a bug, improving documentation, or proposing a new feature, your help is greatly appreciated.

## How to Contribute

1.  **Fork the repository** and create your branch from `main`.
2.  **Set up your development environment.** Make sure you have Python 3.9+ and have run `pip install -r requirements.txt`.
3.  **Make your changes.** Please adhere to the existing code style and project philosophy.
4.  **Write tests** for your changes.
5.  **Ensure all tests pass.**
6.  **Submit a pull request.**

## Extending the System with Custom Modules

The "太公心易" system is designed to be highly extensible. We encourage contributors to develop their own "Mythology Engines" and "Cycle Models" to adapt the system to different cultural contexts or analytical frameworks.

For a detailed guide on how to create and integrate your own custom modules, please see our tutorial:

**[Developer Tutorial: Creating Custom Modules](./docs/custom_modules_tutorial.md)**

This guide will walk you through the process of implementing the required abstract base classes and integrating your new module into the `MarketFSM`.
