Skip to content

Latest commit

 

History

History
135 lines (96 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

135 lines (96 loc) · 3.17 KB

Contributing to mcpbr

Thank you for your interest in contributing to mcpbr! This document provides guidelines and information for contributors.

How to Contribute

Reporting Bugs

Before creating a bug report, please check the existing issues to avoid duplicates. When creating a bug report, include:

  • A clear, descriptive title
  • Steps to reproduce the behavior
  • Expected behavior
  • Actual behavior
  • Your environment (OS, Python version, Docker version)
  • Any relevant logs or error messages

Suggesting Features

Feature requests are welcome! Please:

  • Check existing issues and discussions first
  • Clearly describe the feature and its use case
  • Explain why this feature would be useful to most users

Pull Requests

  1. Fork the repository
  2. Create a feature branch from main
  3. Make your changes
  4. Add or update tests as needed
  5. Ensure all tests pass
  6. Update documentation if needed
  7. Submit a pull request

Development Setup

Prerequisites

  • Python 3.11+
  • Docker
  • An API key for at least one supported provider (OpenRouter, OpenAI, Anthropic, or Google)

Installation

# Clone your fork
git clone https://github.com/greynewell/mcpbr.git
cd mcpbr

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # or `venv\Scripts\activate` on Windows

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

Running Tests

# Run unit tests only (no Docker or API keys required)
pytest -m "not integration"

# Run all tests (requires Docker and API keys)
pytest

# Run with coverage
pytest --cov=mcpbr

Code Style

This project uses:

  • ruff for linting and formatting
  • Type hints throughout the codebase

Before submitting a PR:

# Run linter
ruff check src/ tests/

# Auto-fix issues
ruff check --fix src/ tests/

# Format code
ruff format src/ tests/

Commit Messages

  • Use clear, descriptive commit messages
  • Start with a verb in the imperative mood (e.g., "Add", "Fix", "Update")
  • Keep the first line under 72 characters
  • Reference issues when applicable (e.g., "Fix #123")

Project Structure

mcpbr/
├── src/mcpbr/          # Main package
│   ├── cli.py          # CLI commands
│   ├── config.py       # Configuration models
│   ├── harness.py      # Main orchestrator
│   ├── harnesses.py    # Agent implementations
│   ├── providers.py    # LLM provider abstractions
│   └── ...
├── tests/              # Test suite
├── config/             # Example configurations
└── docs/               # Documentation

Adding New Features

Adding a New Provider

  1. Create a new class in src/mcpbr/providers.py implementing the ModelProvider protocol
  2. Add it to PROVIDER_REGISTRY
  3. Update VALID_PROVIDERS in config.py
  4. Add tests
  5. Update documentation

Adding a New Agent Harness

  1. Create a new class in src/mcpbr/harnesses.py implementing the AgentHarness protocol
  2. Add it to HARNESS_REGISTRY
  3. Update VALID_HARNESSES in config.py
  4. Add tests
  5. Update documentation

Questions?

Feel free to open an issue for any questions about contributing.