Update outdated test documentation in CONTRIBUTING.md #1022
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
case-k-git
force-pushed
the
feature/update-CONTRIBUTING.MD
branch
from
8951f79 to
4d55819
Compare
case-k-git
changed the title
benc-db
reviewed
May 14, 2025
|
|
||
| ### Linting | ||
|
|
||
| This project uses [Black](https://pypi.org/project/black/), [flake8](https://flake8.pycqa.org/en/latest/), and [mypy](https://www.mypy-lang.org/) for linting and static type checks. Run all three with the `linter` command and commit before opening your pull request. | ||
| This project uses [Black](https://pypi.org/project/black/), [flake8](https://flake8.pycqa.org/en/latest/), and [mypy](https://www.mypy-lang.org/) for linting and static type checks. Run all three with the `code-quality` command and commit before opening your pull request. |
There was a problem hiding this comment.
We don't actually use black/flake8 anymore. We use Ruff, which has similar rules implemented, and as you'd expect, is run by code-quality.
benc-db
reviewed
May 14, 2025
| @@ -46,14 +46,14 @@ See [docs/local-dev.md](docs/local-dev.md). | |||
|
|
|||
| ## Code Style | |||
|
|
|||
| We follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) with one exception: lines can be up to 100 characters in length, not 79. You can run [`tox` linter command](#linting) to automatically format the source code before committing your changes. | |||
| We follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) with one exception: lines can be up to 100 characters in length, not 79. You can run [hatch linter command](#linting) to automatically format the source code before committing your changes. | |||
There was a problem hiding this comment.
Maybe just drop this whole paragraph. Also, somewhere in this doc, we should probably just link to docs/dbt-databricks-dev
benc-db
approved these changes
May 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #
Description
The documentation about tests in CONTRIBUTING.md was outdated, so I updated it.
Checklist
CHANGELOG.mdand added information about my change to the "dbt-databricks next" section.