Skip to content

Contributing

Thank you for your interest in contributing to fabric-dw-mcp-cli!

Dev Setup

Recommended: open the repo in GitHub Codespaces or VS Code with the Remote-Containers extension — the devcontainer handles all of steps 1–2 automatically.

  1. Install dependencies
uv sync

  1. Install just (optional, for convenient local checks)

  2. Authenticate with Azure (required for integration tests)

az login

Branch Flow

  • Branch off main for every change.
  • Use descriptive branch names, e.g. feat/add-table-command or fix/connection-timeout.
  • Open a pull request back to main.
  • PR titles must follow Conventional Commits — they become the squash-merge commit message.
  • All PRs are squash-merged.

Conventional Commits

PR titles (and therefore merge commits) must use one of these types:

Type When to use
feat New user-facing feature
fix Bug fix
chore Maintenance, tooling, dependency updates
docs Documentation only
refactor Code change with no feature or fix
test Adding or updating tests
ci CI/CD pipeline changes
perf Performance improvement
revert Revert a previous commit

Example: feat: add DROP TABLE command

Breaking changes must append ! after the type, e.g. feat!: rename CLI entrypoint.

These prefixes are also used by the release-drafter workflow: every PR merged to main updates a running GitHub release draft, categorised by type (feat → Features, fix → Fixes, docs → Documentation, ci/chore → CI / Tooling). When a version tag is pushed, the draft becomes the published release.

Running Checks Locally

Run all gates with just before pushing:

just check

Or run individual checks manually:

Lint

uv run ruff check .
uv run ruff format --check .

Type checking

uvx ty==0.0.44 check src tests

Unit tests

uv run pytest tests/unit -q

Integration tests

Requires a valid az login session and a reachable Fabric workspace.

uv run pytest tests/integration

Code of Conduct

By participating in this project you agree to abide by the Code of Conduct.