Skip to content

Commit

Permalink
Mention Ruff in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mryab committed Jul 13, 2024
1 parent 4ba345d commit cca6ba1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit cca6ba1

Please sign in to comment.