Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#570)
Browse files Browse the repository at this point in the history
  • Loading branch information
KapJI authored Nov 6, 2024
1 parent 4399cf8 commit e8f0349
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ People _love_ thorough bug reports. I'm not even kidding.
## Use a Consistent Coding Style

Install [uv](https://docs.astral.sh/uv/getting-started/installation/) and run `uv sync` to setup the developer environment.
We use [black](https://github.com/ambv/black) and [prettier](https://prettier.io/)
We use [ruff](https://docs.astral.sh/ruff/) and [prettier](https://prettier.io/)
to make sure the code follows the style.

`pre-commit` can be used to run all checks with one command (see dedicated section below).
Expand All @@ -71,13 +71,13 @@ repository to have code style and linting checks.
Activate `pre-commit` git hook:

```console
$ uv run pre-commit install
$ uvx pre-commit install
```

Now the pre-commit tests will be done every time you commit.

You can also run the tests on all repository files manually with this command:

```console
$ uv run pre-commit run --all-files
$ uvx pre-commit run --all-files
```

0 comments on commit e8f0349

Please sign in to comment.