Skip to content

Latest commit

 

History

History
182 lines (129 loc) · 6.73 KB

CONTRIBUTING.md

File metadata and controls

182 lines (129 loc) · 6.73 KB
Raw

Contributing to dbt-adapters

About this document

This document is a guide for anyone interested in contributing to dbt-adapters. It outlines how to install dbt-adapters for development, run tests locally, update documentation, and submit pull requests. This guide assumes users are developing on a Linux or MacOS system. The following utilities are needed or will be installed in this guide:

  • pip
  • virturalenv
  • git
  • changie

If local functional testing is required, then a database instance and appropriate credentials are also required.

In addition to this guide, users are highly encouraged to read the dbt-core CONTRIBUTING.md. Almost all information there is applicable here.

Getting the code

git is required to download, modify, and sync the dbt-adapters code. There are several ways to install Git. For MacOS:

External contributors

Contributors external to the dbt-labs GitHub organization can contribute to dbt-adapters by forking the dbt-adapters repository. For more on forking, check out the GitHub docs on forking. To contribute:

  1. Fork the dbt-labs/dbt-adapters repository (e.g. {forked-org}/dbt-adapters)
  2. Clone {forked-org}/dbt-adapters locally
  3. Check out a new branch locally
  4. Make changes in the new branch
  5. Push the new branch to {forked-org}/dbt-adapters
  6. Open a pull request in dbt-labs/dbt-adapters to merge {forked-org}/dbt-adapters/{new-branch} into main

dbt Labs contributors

Contributors in the dbt Labs GitHub organization have push access to the dbt-adapters repo. Rather than forking dbt-labs/dbt-adapters, use dbt-labs/dbt-adapters directly. To contribute:

  1. Clone dbt-labs/dbt-adapters locally
  2. Check out a new branch locally
  3. Make changes in the new branch
  4. Push the new branch to dbt-labs/dbt-adapters
  5. Open a pull request in dbt-labs/dbt-adapters to merge {new-branch} into main

Developing

Installation

  1. Ensure the latest version of pip is installed: 
    pip install --upgrade pip
  2. Configure and activate a virtual environment using virtualenv as described in Setting up an environment
  3. Install dbt-adapters and development dependencies in the virtual environment 
    pip install -e .[dev]

When dbt-adapters is installed this way, any changes made to the dbt-adapters source code will be reflected in the virtual environment immediately.

Testing

dbt-adapters contains unit and functional tests.

Unit tests

Unit tests can be run locally without setting up a database connection:

# Note: replace $strings with valid names

# run all unit tests in a module
python -m pytest tests/unit/$test_file_name.py
# run a specific unit test
python -m pytest tests/unit/$test_file_name.py::$test_class_name::$test_method_name

Functional tests

Functional tests require a database to test against. There are two primary ways to run functional tests:

  • Tests will run automatically against a dbt Labs owned database during PR checks
  • Tests can be run locally by configuring a test.env file with appropriate ENV variables: 
    cp test.env.example test.env
$EDITOR test.env

WARNING: The parameters in test.env must link to a valid database. test.env is git-ignored, but be extra careful to never check in credentials or other sensitive information when developing.

Functional tests can be run locally with a valid database connection configured in test.env:

# Note: replace $strings with valid names

# run all functional tests in a directory
python -m pytest tests/functional/$test_directory
# run all functional tests in a module
python -m pytest tests/functional/$test_dir_and_filename.py
# run all functional tests in a class
python -m pytest tests/functional/$test_dir_and_filename.py::$test_class_name
# run a specific functional test
python -m pytest tests/functional/$test_dir_and_filename.py::$test_class_name::$test__method_name

Documentation

User documentation

Many changes will require an update to dbt-adapters user documentation. All contributors, whether internal or external, are encouraged to open an issue or PR in the docs repo when submitting user-facing changes. Here are some relevant links:

CHANGELOG entry

dbt-adapters uses changie to generate CHANGELOG entries. Follow the steps to install changie.

Once changie is installed and the PR is created, run:

changie new

changie will walk through the process of creating a changelog entry. Remember to commit and push the file that's created.

NOTE: Do not edit the CHANGELOG.md directly. Any modifications will be lost by the consolidation process.

Submitting a pull request

Signing the CLA

NOTE: All contributors to dbt-adapter must sign the Contributor License Agreement(CLA).

Maintainers will be unable to merge contributions until the contributor signs the CLA. This is a one time requirement, not a per-PR requirement. Even without a CLA, anyone is welcome to open issues and comment on existing issues or PRs.

Opening a pull request

A dbt-adapters maintainer will be assigned to review each PR based on priority and capacity. They may suggest code revisions for style and clarity or they may request additional tests. These are good things! dbt Labs believes that contributing high-quality code is a collaborative effort. The same process is followed whether the contributor is external or another dbt-adapters maintainer. Once all tests are passing and the PR has been approved by the appropriate code owners, a dbt-adapters maintainer will merge the changes into main.

And that's it! Happy developing 🎉