Contributing

Welcome to ML4T Data! We appreciate your interest in contributing.

Ways to Contribute

• Create a Provider

  ---

  Add support for a new data source.

  Provider Guide

• Fix Bugs

  ---

  Help improve reliability and fix issues.

  Testing Guide

• Improve Docs

  ---

  Enhance documentation and examples.

  Architecture

Quick Start

# Clone the repository
git clone https://github.com/stefan-jansen/ml4t-data.git
cd ml4t-data

# Install with dev dependencies
uv sync --all-extras

# Install pre-commit hooks
pre-commit install

# Run tests
pytest

Code Style

• Formatter: ruff (100 char line length)
• Type checking: mypy strict mode
• Docstrings: Google style
• Tests: pytest with 80%+ coverage

Pull Request Process

1. Fork the repository
2. Create a feature branch
3. Make your changes with tests
4. Run pre-commit run --all-files
5. Submit a pull request

Getting Help

• GitHub Issues
• Discussions