Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

34 lines (20 loc) · 1.01 KB
Raw

Contributing 🌳

Prerequisites

  • make
  • node (required for pyright)
  • python >= 3.9

Getting started

make install creates the dev environment with:

  • a virtualenv in .venv/
  • pyright in node_modules/
  • git hooks for formatting & linting on git push (these also run in CI)

. .venv/bin/activate activates the virtualenv.

The make targets will update the virtualenv when pyproject.toml changes.

Usage

Run make to see the options for running tests, linting, formatting etc.

Raising a PR

PR titles use conventional commit prefixes where:

  • feat adding an unimplemented feature
  • fix fixing an already implemented feature

Changes to behaviour covered by a test is considered a breaking change. Breaking changes are indicated with an exclamation mark in the title.

New features and bug fixes require a minimal test case that mimics the behaviour of Snowflake and passes if run against a real Snowflake instance, or documents clearly where it deviates.