Skip to content

Latest commit

 

History

History
102 lines (72 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

102 lines (72 loc) · 3.67 KB
Raw

Contribution guidelines

Note: This document contains contribution guidelines for the Elementary dbt package. If you wish to contribute to the Elementary CLI (edr), please refer to the CLI contribution guidelines.

Getting started with development

Setup

(1) Clone the repository

git clone https://github.com/elementary-data/dbt-data-reliability.git
cd dbt-data-reliability

(2) Edit packages.yml in your dbt project

packages:
  - local: /path/to/dbt-data-reliability

(3) Install the package

dbt deps

You're done. Running dbt will now run the code in your local repository.

First time contributors

If you're looking for things to help with, browse our issue tracker!

In particular, look for:

You do not need to ask for permission to work on any of these issues. Just fix the issue yourself and open a pull request.

To get help fixing a specific issue, it's often best to comment on the issue itself. You're much more likely to get help if you provide details about what you've tried and where you've looked. Slack can also be a good place to ask for help.

Submitting changes

Even more excellent than a good bug report is a fix for a bug, or the implementation of a much-needed new feature. We'd love to have your contributions.

We use the usual GitHub pull-request flow, which may be familiar to you if you've contributed to other projects on GitHub. For the mechanics, view this guide.

If your change will be a significant amount of work to write, we highly recommend starting by opening an issue laying out what you want to do. That lets a conversation happen early in case other contributors disagree with what you'd like to do or have ideas that will help you do it.

The best pull requests are focused, clearly describe what they're for and why they're correct, and contain tests for whatever changes they make to the code's behavior. As a bonus these are easiest for someone to review, which helps your pull request get merged quickly!

Running integration tests

For every PR we merge, we require integration tests to pass successfully on all supported database platforms (Snowflake, Bigquery, Redshift, Databricks and Postgres).

Clearly you might not have a setup for all of these, so the expectation is that you'll run the tests on the platform you're using and make sure everything passes. We also encourage you to add new tests for any new non-trivial functionality.

Our tests are located under the integration_tests directory, and written using the py-test framework. In order to run them, please follow these steps:

  1. Install dependencies:
cd integration_tests
pip install -r requirements.txt
dbt deps --project-dir dbt_project

  1. Create a dbt profile named elementary_tests, with a target corresponding to the database you are using. For more details on how to set a dbt profile please click here.

  2. Run the tests:

cd tests
py.test -vvv --target <your_target>