|
2 | 2 |
|
3 | 3 | `dbt-core` is open source software. It is what it is today because community members have opened issues, provided feedback, and [contributed to the knowledge loop](https://www.getdbt.com/dbt-labs/values/). Whether you are a seasoned open source contributor or a first-time committer, we welcome and encourage you to contribute code, documentation, ideas, or problem statements to this project. |
4 | 4 |
|
5 | | -1. [About this document](#about-this-document) |
6 | | -2. [Getting the code](#getting-the-code) |
7 | | -3. [Setting up an environment](#setting-up-an-environment) |
8 | | -4. [Running dbt-core in development](#running-dbt-core-in-development) |
9 | | -5. [Testing dbt-core](#testing) |
10 | | -6. [Debugging](#debugging) |
11 | | -7. [Adding or modifying a changelog entry](#adding-or-modifying-a-changelog-entry) |
12 | | -8. [Submitting a Pull Request](#submitting-a-pull-request) |
13 | | -9. [Troubleshooting Tips](#troubleshooting-tips) |
| 5 | +- [Contributing to `dbt-core`](#contributing-to-dbt-core) |
| 6 | + - [About this document](#about-this-document) |
| 7 | + - [Notes](#notes) |
| 8 | + - [Getting the code](#getting-the-code) |
| 9 | + - [Installing git](#installing-git) |
| 10 | + - [External contributors](#external-contributors) |
| 11 | + - [dbt Labs contributors](#dbt-labs-contributors) |
| 12 | + - [Setting up an environment](#setting-up-an-environment) |
| 13 | + - [Tools](#tools) |
| 14 | + - [Virtual environments](#virtual-environments) |
| 15 | + - [Docker and `docker-compose`](#docker-and-docker-compose) |
| 16 | + - [Postgres (optional)](#postgres-optional) |
| 17 | + - [Running `dbt-core` in development](#running-dbt-core-in-development) |
| 18 | + - [Installation](#installation) |
| 19 | + - [Running `dbt-core`](#running-dbt-core) |
| 20 | + - [Testing](#testing) |
| 21 | + - [Initial setup](#initial-setup) |
| 22 | + - [Test commands](#test-commands) |
| 23 | + - [Makefile](#makefile) |
| 24 | + - [`pre-commit`](#pre-commit) |
| 25 | + - [`tox`](#tox) |
| 26 | + - [`pytest`](#pytest) |
| 27 | + - [Unit, Integration, Functional?](#unit-integration-functional) |
| 28 | + - [Debugging](#debugging) |
| 29 | + - [Assorted development tips](#assorted-development-tips) |
| 30 | + - [Adding or modifying a CHANGELOG Entry](#adding-or-modifying-a-changelog-entry) |
| 31 | + - [Submitting a Pull Request](#submitting-a-pull-request) |
| 32 | + - [Troubleshooting Tips](#troubleshooting-tips) |
14 | 33 |
|
15 | 34 | ## About this document |
16 | 35 |
|
@@ -55,7 +74,7 @@ There are some tools that will be helpful to you in developing locally. While th |
55 | 74 |
|
56 | 75 | These are the tools used in `dbt-core` development and testing: |
57 | 76 |
|
58 | | -- [`tox`](https://tox.readthedocs.io/en/latest/) to manage virtualenvs across python versions. We currently target the latest patch releases for Python 3.8, 3.9, 3.10 and 3.11 |
| 77 | +- [`tox`](https://tox.readthedocs.io/en/latest/) to manage virtualenvs across python versions. We currently target the latest patch releases for Python 3.10, 3.11, 3.12, and 3.13 |
59 | 78 | - [`pytest`](https://docs.pytest.org/en/latest/) to define, discover, and run tests |
60 | 79 | - [`flake8`](https://flake8.pycqa.org/en/latest/) for code linting |
61 | 80 | - [`black`](https://github.com/psf/black) for code formatting |
|
0 commit comments