Development Setup

Set up your development environment for contributing.

Prerequisites

• Python 3.12 or 3.13
• Git
• uv or pip

Clone and Install

# Clone repository
git clone https://github.com/nibzard/llm-answer-watcher.git
cd llm-answer-watcher

# Install with uv (recommended)
uv sync --dev

# Or with pip
pip install -e ".[dev]"

Development Tools

Testing

# Run all tests
pytest

# Run with coverage
pytest --cov=llm_answer_watcher --cov-report=html

# Run specific test
pytest tests/test_config_loader.py::test_load_valid_config

Linting

# Check code quality
ruff check .

# Auto-fix issues
ruff check . --fix

# Format code
ruff format .

Documentation

# Build docs
mkdocs build

# Serve docs locally
mkdocs serve

Making Changes

1. Create a branch: git checkout -b feature/my-feature
2. Make changes
3. Run tests: pytest
4. Run linting: ruff check .
5. Commit: git commit -m "feat: add feature"
6. Push: git push origin feature/my-feature
7. Create Pull Request

See Code Standards for coding guidelines.