CONTRIBUTING.md

Contributing to ModelPulse

Thanks for your interest in contributing! Here's how to get started.

Development Setup

1. Clone the repo and install dependencies:

git clone https://github.com/DevStrategist/ModelPulse.git
cd ModelPulse/llm-benchmark
pip install -r requirements.txt
pip install -e ".[dev]"

2. Run the app:

python main.py

3. Run the tests:

pytest tests/ -v

Adding a New Provider

The client architecture makes it straightforward to add new LLM providers:

1. Create a new file in src/clients/ (e.g., anthropic_client.py)
2. Extend BaseClient and implement get_models() and chat()
3. Register it in src/clients/__init__.py
4. Add the source option in src/gui/main_window_clean_dark.py

See src/clients/groq_client.py for a clean example.

Code Style

• Format with Black (black --line-length 100)
• Lint with Ruff (ruff check .)
• Use type hints where practical
• Keep async/await patterns consistent with existing code

Pull Requests

1. Fork the repo and create a feature branch
2. Make your changes with clear commit messages
3. Ensure tests pass (pytest tests/ -v)
4. Open a PR with a description of what changed and why

Reporting Issues

Open an issue with:

• Steps to reproduce
• Expected vs actual behavior
• Python version and OS