Skip to content

docs: add TESTING.md guide for contributors (resolves #9351)#12739

Open
jayshilj wants to merge 1 commit into
dbt-labs:main_backupfrom
jayshilj:docs/add-testing-guide
Open

docs: add TESTING.md guide for contributors (resolves #9351)#12739
jayshilj wants to merge 1 commit into
dbt-labs:main_backupfrom
jayshilj:docs/add-testing-guide

Conversation

@jayshilj
Copy link
Copy Markdown

docs: add TESTING.md guide for contributors (resolves #9351)

Resolves #9351

Problem

External contributors to dbt-core currently have no dedicated reference
for understanding what types of tests to add when submitting a PR. This
makes it harder for first-time contributors to know whether to write a unit
test or a functional test, and where to find existing examples to follow.

Solution

Added a new TESTING.md living document at the root of the repo that covers:

  • When to write unit tests (tests/unit/) with links to existing examples
  • When to write functional/integration tests (tests/functional/) with examples and considerations
  • How to run each type of test locally using hatch and pytest

Also added a reference link to TESTING.md in the ### Unit, Integration, Functional?
section of CONTRIBUTING.md so contributors can discover it naturally.

Checklist

  • I have read the contributing guide and understand what's expected of me.
  • I have run this code in development, and it appears to resolve the stated issue.
  • This PR includes tests, or tests are not required or relevant for this PR.
  • This PR has no interface changes (e.g., macros, CLI, logs, JSON artifacts, config files, adapter interface, etc.) or this PR has already received feedback and approval from Product or DX.
  • This PR includes type annotations for new and modified functions.

docs: add TESTING.md guide for contributors (resolves dbt-labs#9351)
@jayshilj jayshilj requested a review from a team as a code owner March 30, 2026 00:51
@cla-bot
Copy link
Copy Markdown

cla-bot Bot commented Mar 30, 2026

Thanks for your pull request, and welcome to our community! We require contributors to sign our Contributor License Agreement and we don't seem to have your signature on file. Check out this article for more information on why we have a CLA.

In order for us to review and merge your code, please submit the Individual Contributor License Agreement form attached above above. If you have questions about the CLA, or if you believe you've received this message in error, please reach out through a comment on this PR.

CLA has not been signed by users: @jayshilj

@github-actions github-actions Bot added the community This PR is from a community member label Mar 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community This PR is from a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[CT-3532] [DEV UX] Have a guide for how to add tests in dbt-core

1 participant