From cca6ba1fe3d9ebcc63f6ce605bfbd70a329b02f4 Mon Sep 17 00:00:00 2001 From: Max Ryabinin Date: Sat, 13 Jul 2024 13:47:40 +0100 Subject: [PATCH] Mention Ruff in CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5dc3a5223..1629095b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,8 +36,8 @@ with the following rules: * The code must follow [PEP8](https://www.python.org/dev/peps/pep-0008/) unless absolutely necessary. Also, each line cannot be longer than 119 characters. -* We use [black](https://github.com/psf/black) for code formatting and [isort](https://github.com/PyCQA/isort) for - import sorting. Before submitting a PR, make sure to install and run `black .` and `isort .` in the root of the +* We use [black](https://github.com/psf/black) for code formatting, [isort](https://github.com/PyCQA/isort) for import sorting, and [ruff](https://github.com/astral-sh/ruff) as a linter. + Before submitting a PR, make sure to install and run `black .` and `isort .` in the root of the repository. Also, you may want to check your code for typos by running `codespell --skip=".git"`, though there might be false positives. * We highly encourage the use of [typing](https://docs.python.org/3/library/typing.html) where applicable.