43 lines (30 loc) · 989 Bytes

Contributing to Home Assistant MCP Server

Thank you for your interest in contributing!

🚀 Quick Start

Fork and clone the repository
Install: uv sync --group dev
Test: uv run pytest tests/src/e2e/ -v (requires Docker)
Make changes and commit
Open Pull Request

🧪 Testing

See tests/README.md.

🛠️ Development

Setup:

cp .env.example .env    # Edit with your HA details
uv sync --group dev

Code quality:

uv run ruff format src/ tests/     # Format
uv run ruff check --fix src/ tests/ # Lint
uv run mypy src/                   # Type check

📋 Guidelines

Code: Follow existing patterns, add type hints, test new features
Docs: Update README.md for user-facing changes
PRs: Use the template, ensure tests pass

🏗️ Stuck?

Open an Issue.
See AGENTS.md for additional tips.

Thank you for contributing! 🎉