From c8e85c490a4b71118b176175a83109da7cded18f Mon Sep 17 00:00:00 2001 From: Tuomas Haapala Date: Thu, 31 Oct 2024 15:50:19 +0200 Subject: [PATCH] chore: update README about Ruff --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 86e1ebef..8b579988 100644 --- a/README.md +++ b/README.md @@ -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