Contributing¶

Thank you for your interest in contributing to Lean Explore!

Getting Started¶

Fork the repository
Clone your fork
Install in development mode:

pip install -e ".[dev]"

Run tests:

make test

Development Setup¶

Prerequisites¶

Python 3.10+
Git
(Optional) Local Lean 4 installation for extractor scripts

Installation¶

# Clone repository
git clone https://github.com/KellyJDavis/lean-explore.git
cd lean-explore

# Install in development mode
pip install -e ".[dev]"

# Run tests
make test

Code Style¶

We use: - Ruff for linting and formatting - Google-style docstrings - Type hints for all functions

Formatting¶

# Format code
ruff format .

# Check linting
ruff check .

Testing¶

# Run all tests
make test

# Run with coverage
make test-cov

# Run specific test file
pytest tests/lean_explore/api/test_client.py

Documentation¶

Documentation is built with MkDocs:

# Install docs dependencies
pip install mkdocs-material mkdocstrings[python]

# Serve locally
mkdocs serve

# Build
mkdocs build

Pull Request Process¶

Create a feature branch
Make your changes
Add tests if applicable
Ensure all tests pass
Update documentation if needed
Submit a pull request

Code of Conduct¶

Be respectful and inclusive in all interactions.

Questions?¶

Open an issue or start a discussion on GitHub.