CONTRIBUTING.md

Contributing

Requirements

• Poetry (analyze, test)
• npm (analyze)
• addlicense (analyze)
• Google Cloud CLI (test)

Install

poetry install --all-extras

Analyze (format, lint, type check)

poetry shell
nox -t analyze

Test

Unit

poetry shell
nox -s tests -- unit

Integration

poetry shell
BQMS_VERBOSE="False" \
BQMS_MULTITHREADED="True" \
BQMS_PROJECT="<YOUR_TEST_PROJECT>" \
BQMS_GCS_BUCKET="<YOUR_TEST_BUCKET>" \
nox -s tests -- integration

Unit and Integration

poetry shell
BQMS_VERBOSE="False" \
BQMS_MULTITHREADED="True" \
BQMS_PROJECT="<YOUR_TEST_PROJECT>" \
BQMS_GCS_BUCKET="<YOUR_TEST_BUCKET>" \
nox -s tests

Logs

To view all logs while running tests:

poetry shell
nox -s tests --verbose -- unit pytest_verbose

Docs

Be sure to update the README and Codelab if necessary.