Contributing¶

Thanks for your interest in improving UML-MCP. The full guidelines live in the repo root; this page summarises the most useful entry points.

Document	Why
`CONTRIBUTING.md`	Local setup, branching model, commit and PR conventions.
`CODE_OF_CONDUCT.md`	Community expectations.
`SECURITY.md`	How to responsibly report a security issue.

Quick setup¶

git clone https://github.com/antoinebou12/uml-mcp.git
cd uml-mcp
uv sync --all-groups
uv run pre-commit install   # if pre-commit hooks are available
uv run pytest tests/ -v

Pull request checklist¶

Tests pass (uv run pytest tests/ -v).
Lint clean (uv run ruff check . and uv run ruff format --check .).
Public-facing changes are reflected in the docs (docs/).
If you touched MCP tools/resources/prompts, the Reference section still matches reality.
If you added an env var, update Configuration.

Reporting issues¶

Bug reports: open a GitHub issue with reproduction steps.
Security: see SECURITY.md. Do not post details in a public issue.
Feature requests: an issue with use case and an example call goes a long way.

Working on docs only?

Run uv run mkdocs serve and edit pages live; rebuilds are typically sub-second. The Deploy docs workflow publishes to GitHub Pages on every push to main.