Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ git checkout main
git pull upstream main --ff-only
```

### Code Standards and tests (ruff, mypy, pytest, and pre-commit)
### Code Standards and tests (ruff, mypy, pytest, and prek)

meilisearch-python-sdk uses [ruff](https://github.com/charliermarsh/ruff), and
[mypy](https://mypy.readthedocs.io/en/stable/) to ensure consistent code formatting.
Expand All @@ -94,18 +94,18 @@ uv run ruff check .
uv run mypy meilisearch_python_sdk
```

It is also suggested that you setup [pre-commit](https://pre-commit.com/) in order to run linting
when you commit changes to you branch. To setup pre-commit for this project run:
It is also suggested that you setup [prek](https://github.com/j178/prek) in order to run linting
when you commit changes to you branch. To setup prek for this project run:

```sh
pre-commit install
prek install
```

After this pre-commit will automatically run any time you check in code to your branches. You can
also run pre-commit at any time with:
After this prek will automatically run any time you check in code to your branches. You can
also run prek at any time with:

```sh
pre-commit run --all-files
prek run --all-files
```

### Type Hints
Expand Down Expand Up @@ -224,7 +224,7 @@ Now you can commit your changes in your local repository:
git commit -am 'Some short helpful message to describe your changes'
```

If you setup pre-commit and any of the tests fail the commit will be cancelled and you will need to
If you setup prek and any of the tests fail the commit will be cancelled and you will need to
fix any errors. Once the errors are fixed you can run the same git commit command again.

## Push your changes
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ dev = [
"mkdocs-material==9.7.1",
"mkdocstrings[python]==1.0.0",
"mypy[faster-cache]==1.19.1",
"pre-commit==4.5.1",
"pytest==9.0.2",
"pytest-cov==7.0.0",
"pytest-asyncio==1.3.0",
"pytest-xdist==3.8.0",
"prek>=0.2.27",
"ruff==0.14.10",
"types-aiofiles==25.1.0.20251011",
"typing-extensions==4.15.0",
Expand Down
94 changes: 21 additions & 73 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.