Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (45 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

66 lines (45 loc) · 1.02 KB

Contributing

Prerequisites

Setup

git clone https://github.com/Pyhive/Pyhiveapi.git
cd Pyhiveapi
make setup

Or manually:

pip install -e ".[dev]"
pre-commit install

Running tests

pytest tests/

With coverage:

pytest tests/ --cov

Running linters

pre-commit run --all-files

Individual tools:

ruff check src/          # lint
ruff format src/         # format
mypy src/                # type check

Generating the sync package

The pyhiveapi (sync) package is auto-generated from the async source in src/:

python setup.py build_py

Never edit files under pyhiveapi/ directly — edit src/ only.

Submitting a PR

  1. Branch off dev (not master)
  2. Make your changes and ensure pre-commit run --all-files passes
  3. Push and open a PR against dev
  4. Direct PRs to master are blocked

Please read our Code of Conduct before contributing.