Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (53 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

76 lines (53 loc) · 1.85 KB

Contributing to eve-mcp

Thank you for your interest in contributing! eve-mcp is an MCP server that exposes the EVE (Earth Virtual Expert) API as a set of MCP tools. See the README for what the project does and how to use it.

Development setup

Clone with submodules and install with Poetry:

git clone --recurse-submodules https://github.com/FrontierDevelopmentLab/eve-mcp.git
cd eve-mcp
poetry install

If you cloned without --recurse-submodules:

git submodule update --init --recursive

Then install the pre-commit hooks:

poetry run pre-commit install

Code quality

Pre-commit runs black, isort, autoflake, mypy, pylint, detect-secrets, and pytest with coverage. Run the full suite locally before pushing:

poetry run pre-commit run --all-files

If a hook fails, fix the underlying issue rather than bypassing the hook. If detect-secrets flags a false positive, update the baseline:

poetry run detect-secrets scan --baseline .secrets.baseline

Testing

poetry run pytest

New behaviour should ship with tests, and coverage is expected to stay at 100%.

Pull requests

  • Fork the repo and branch off main.
  • Use a short branch prefix: feat/, fix/, docs/, or chore/ etc.
  • Keep each PR focused on one logical change.
  • In the PR description, explain what changed and why, and link any related issue.
  • Commit messages: imperative mood, focused on the why.
  • Be ready to iterate on review feedback.

Reporting issues

Open a GitHub issue with:

  • steps to reproduce,
  • expected vs actual behaviour,
  • your environment (Python version, OS, relevant package versions).

For maintainers

Maintainers can push branches directly to the repo; the same branch naming, PR, and review expectations apply.