Skip to content

Commit

Permalink
chore: update README about Ruff
Browse files Browse the repository at this point in the history
  • Loading branch information
tuomas777 committed Nov 1, 2024
1 parent b865cb7 commit c8e85c4
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,11 +296,14 @@ Translations are maintained on [Transifex][tx].

### Code format

This project uses
[`black`](https://github.com/ambv/black),
[`flake8`](https://github.com/pycqa/flake8) and
[`isort`](https://github.com/pycqa/isort)
for code formatting and quality checking.
This project uses [Ruff](https://docs.astral.sh/ruff/) for code formatting and quality checking.

Basic `ruff` commands:

* lint: `ruff check`
* apply safe lint fixes: `ruff check --fix`
* check formatting: `ruff format --check`
* format: `ruff format`

[`pre-commit`](https://pre-commit.com/) can be used to install and
run all the formatting tools as git hooks automatically before a
Expand Down

0 comments on commit c8e85c4

Please sign in to comment.