Skip to content

Contributing

Thank you for your interest in contributing to Evaldeck!

Ways to Contribute

  • Bug Reports - Found a bug? Open an issue
  • Feature Requests - Have an idea? Start a discussion
  • Code Contributions - Fix bugs, add features, improve docs
  • Documentation - Improve guides, add examples, fix typos

Quick Start

# Clone the repo
git clone https://github.com/tantra-run/evaldeck-py.git
cd evaldeck

# Create virtual environment
python -m venv venv
source venv/bin/activate

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

# Install pre-commit hooks
pre-commit install

# Run tests
pytest

Guide Sections

Guide Description
Development Setup Set up your development environment
Code Standards Style, testing, and commit conventions
Adding Graders Create new grader types
Adding Metrics Create new metrics
Adding Integrations Support new frameworks

Contribution Workflow

  1. Fork the repository
  2. Create a branch from main
  3. Make changes following our code standards
  4. Add tests for new functionality
  5. Run checks (pytest, ruff, mypy)
  6. Open a PR with a clear description

Getting Help