Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (46 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

64 lines (46 loc) · 1.48 KB

Contributing to NetLogo MCP

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

Development Setup

git clone https://github.com/Razee4315/NetLogo_MCP.git
cd NetLogo_MCP
pip install -e ".[dev]"
pre-commit install

You'll need Java JDK 11+ and NetLogo 7.0+ installed for integration testing. Unit tests use mocks and don't require either.

Running Tests

# Run tests
pytest tests/ -v

# Run tests with coverage report
pytest tests/ -v --cov=netlogo_mcp --cov-report=term-missing

Code Quality

This project uses Ruff for linting/formatting and mypy for type checking. Pre-commit hooks run these automatically, or run them manually:

# Lint
ruff check src/ tests/

# Format
ruff format src/ tests/

# Type check
mypy src/netlogo_mcp/

Submitting Changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-feature)
  3. Make your changes
  4. Run tests and linting to make sure nothing breaks
  5. Commit with a clear message
  6. Push to your fork and open a Pull Request

Reporting Issues

Open an issue on GitHub with:

  • What you expected to happen
  • What actually happened
  • Your Python, Java, and NetLogo versions
  • Any error messages or logs

Code Style

  • Follow existing patterns in the codebase
  • Keep functions focused and well-named
  • Add type hints to new functions
  • Add tests for new tools or resources
  • Run ruff format before committing