Skip to content

Latest commit

 

History

History
192 lines (128 loc) · 9.51 KB

CONTRIBUTING.md

File metadata and controls

192 lines (128 loc) · 9.51 KB
Raw

Contributing to dlt

Thank you for considering contributing to dlt! We appreciate your help in making dlt better. This document will guide you through the process of contributing to the project.

Table of Contents

  1. Getting Started
  2. Submitting Changes
  3. Adding or updating core dependencies
  4. Linting
  5. Testing
  6. Local Development
  7. Publishing (Maintainers Only)
  8. Resources

Before You Begin

  • Proposing significant changes or enhancements: If you're thinking about making significant changes, make sure to submit an issue first. This ensures your efforts align with the project's direction and that you don't invest time on a feature that may not be merged.

  • Fixing bugs:

    • Check existing issues: search open issues to see if the bug you've found is already reported.
      • If not reported, create a new issue. You're more than welcome to fix it and submit a pull request with your solution. Thank you!
      • If the bug is already reported, please leave a comment on that issue stating you're working on fixing it. This helps keep everyone updated and avoids duplicate efforts.

Getting Started

To get started, follow these steps:

  1. Fork the dlt repository and clone it to your local machine.
  2. Install poetry with make install-poetry (or follow the official instructions).
  3. Run make dev to install all dependencies including dev ones.
  4. Start working in the poetry shell by executing poetry shell.

Submitting Changes

When you're ready to contribute, follow these steps:

  1. Create an issue describing the feature, bug fix, or improvement you'd like to make.
  2. Create a new branch in your forked repository for your changes.
  3. Write your code and tests.
  4. Lint your code by running make lint and test common modules with make test-common.
  5. If you're working on destination code, contact us to get access to test destinations.
  6. Create a pull request targeting the devel branch of the main repository.

Note: for some special cases, you'd need to contact us to create a branch in this repository (not fork). See below.

Active branches

We use devel (which is our default Github branch) to prepare a next release of dlt. We accept all regular contributions there (including most of the bugfixes).

We use master branch for hot fixes (including documentation) that needs to be released out of the normal schedule.

On the release day, devel branch is merged into master. All releases of dlt happen only from the master.

Branch naming rules

We want to make sure that our git history explains in a human readable way what has been changed with which Branch or PR. To this end, we are using the following branch naming pattern (all lowercase and dashes, no underscores):

{category}/{ticket-id}-description-of-the-branch
# example:
feat/4922-add-avro-support

Branch categories

  • feat - a new feature that is being implemented (ticket required)
  • fix - a change that fixes a bug (ticket required)
  • exp - an experiment where we are testing a new idea or want to demonstrate something to the team, might turn into a feat later (ticket encouraged)
  • test - anything related to the tests (ticket encouraged)
  • blogs - a new entry to our blog (ticket optional)
  • docs - a change to our docs (ticket optional)

Ticket Numbers

We encourage you to attach your branches to a ticket, if none exists, create one and explain what you are doing. For feat and fix branches, tickets are mandatory, for exp and test branches encouraged and for blogs and docs branches optional.

Submitting a hotfix

We'll fix critical bugs and release dlt out of the schedule. Follow the regular procedure, but make your PR against master branch. Please ping us on Slack if you do it.

Testing with Github Actions

We enable our CI to run tests for contributions from forks. All the tests are run, but not all destinations are available due to credentials. Currently only the duckdb and postgres are available to forks.

Submitting Changes Requiring Full CI Credentials.

In case you submit a new destination or make changes to a destination that require credentials (so Bigquery, Snowflake, buckets etc.) you should contact us so we can add you as contributor. Then you should make a PR directly to the dlt repo.

Adding or updating core dependencies

Our objective is to maintain stability and compatibility of dlt across all environments. By following these guidelines, we can make sure that dlt stays secure, reliable and compatible. Please consider the following points carefully when proposing updates to dependencies.

Updating guidelines

  1. Critical security or system integrity updates only: Major or minor version updates to dependencies should only be considered if there are critical security vulnerabilities or issues that impact the system's integrity. In such cases, updating is necessary to protect the system and the data it processes.

  2. Using the '>=' operator: When specifying dependencies, please make sure to use the >= operator while also maintaining version minima. This approach ensures our project remains compatible with older systems and setups, mitigating potential unsolvable dependency conflicts.

For example, if our project currently uses a package example-package==1.2.3, and a security update is released as 1.2.4, instead of updating to example-package==1.2.4, we can set it to example-package>=1.2.3,<2.0.0. This permits the necessary security update and at the same time prevents the automatic jump to a potentially incompatible major version update in the future. The other important note on using possible version minimas is to prevent potential cases where package versions will not be resolvable.

Linting

dlt uses mypy and flake8 with several plugins for linting.

Testing

dlt uses pytest for testing.

Common Components

To test common components (which don't require external resources), run make test-common.

Local Destinations

To test local destinations (duckdb and postgres), run make test-load-local.

External Destinations

To test external destinations use make test. You will need the following external resources

  1. BigQuery project
  2. Redshift cluster
  3. Postgres instance. You can find a docker compose for postgres instance here. When run the instance is configured to work with the tests.
cd tests/load/postgres/
docker-compose up --build -d

See tests/.example.env for the expected environment variables and command line example to run the tests. Then create tests/.env from it. You configure the tests as you would configure the dlt pipeline. We'll provide you with access to the resources above if you wish to test locally.

Local Development

Use Python 3.8 for development, as it's the lowest supported version for dlt. You'll need distutils and venv. You may also use pyenv, as suggested by poetry.

Publishing (Maintainers Only)

This section is intended for project maintainers who have the necessary permissions to manage the project's versioning and publish new releases. If you're a contributor, you can skip this section.

Please read how we version the library first.

The source of truth for the current version is pyproject.toml, and we use poetry to manage it.

Regular release

Before publishing a new release, make sure to bump the project's version accordingly:

  1. Check out the devel branch.
  2. Use poetry version patch to increase the patch version
  3. Run make build-library to apply the changes to the project.
  4. Create a new branch, and submit the PR to devel. Go through the standard process to merge it.
  5. Create a merge PR from devel to master and merge it with a merge commit.

Hotfix release

  1. Check out the master branch
  2. Use poetry version patch to increase the patch version
  3. Run make build-library to apply the changes to the project.
  4. Create a new branch, submit the PR to master and merge it.

Pre-release

Occasionally we may release an alpha version directly from the branch.

  1. Check out the devel branch
  2. Use poetry version prerelease to increase the alpha version
  3. Run make build-library to apply the changes to the project.
  4. Create a new branch, and submit the PR to devel and merge it.

Publishing to PyPI

Once the version has been bumped, follow these steps to publish the new release to PyPI:

  1. Ensure that you are on the master branch and have the latest code that has passed all tests on CI.
  2. Verify the current version with poetry version.
  3. Obtain a PyPI access token and configure it with poetry config pypi-token.pypi your-api-token.
  4. Run make publish-library to publish the new version.
  5. Create a release on GitHub, using the version and git tag as the release name.

Resources

If you have any questions or need help, don't hesitate to reach out to us. We're here to help you succeed in contributing to dlt. Happy coding!