Contributing to pbi-cli

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

Development Setup

git clone https://github.com/MinaSaad1/pbi-cli.git
cd pbi-cli
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate
pip install -e ".[dev]"

Running Tests

pytest                          # all tests
pytest -x -q                    # stop on first failure
pytest --cov=pbi_cli            # with coverage
pytest -m "not e2e"             # skip integration tests

Code Quality

All checks must pass before submitting a PR:

ruff check src/ tests/          # linting
ruff format --check src/ tests/ # formatting
mypy src/                       # type checking

Pull Request Process

Fork the repo and create a feature branch from master
Write tests for new functionality (target 80%+ coverage)
Ensure all checks pass (ruff, mypy, pytest)
Keep PRs focused on a single change
Use conventional commit messages: feat:, fix:, docs:, test:, chore:

Project Structure

src/pbi_cli/
  commands/       # Click command groups (one file per domain)
  core/           # MCP client, config, output formatting
  skills/         # Claude Code SKILL.md files (bundled)
  utils/          # REPL, helpers
tests/            # Mirrors src/ structure

Adding a New Command Group

Create src/pbi_cli/commands/your_cmd.py
Use run_tool() from _helpers.py for MCP calls
Register the group in main.py _register_commands()
Add tests in tests/test_commands/test_your_cmd.py

Adding a New Skill

Create src/pbi_cli/skills/your-skill/SKILL.md
Follow the frontmatter format from existing skills
Test with pbi skills list and pbi skills install

Reporting Issues

Open an issue on GitHub with:

What you expected to happen
What actually happened
Steps to reproduce
Python version and OS

Code of Conduct

Be respectful and constructive. We're all here to make Power BI development better.

2 KiB Raw Blame History