Skip to content

Commit 00af416

Browse files
committed
update contributing doc
1 parent b27efcc commit 00af416

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/contributing.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,27 @@ Code Style
2828
==========
2929

3030
The project uses `flake8 <https://flake8.pycqa.org/en/latest/>`_ for linting,
31-
`black <https://black.readthedocs.io/en/stable/>`_ for formatting the code,
32-
`isort <https://pycqa.github.io/isort/>`_ for formatting and sorting imports,
31+
`ruff <https://docs.astral.sh/ruff/>`_ for formatting the code and sorting imports,
3332
and `pre-commit <https://pre-commit.com/>`_ for checking/fixing commits for
3433
correctness before they are made.
3534

3635
You will need to install ``pre-commit`` yourself, and then ``pre-commit`` will
37-
take care of installing ``flake8``, ``black`` and ``isort``.
36+
take care of installing ``flake8`` and ``ruff``.
3837

3938
After cloning your repository, go into it and run::
4039

4140
pre-commit install
4241

4342
to install the hooks. On the next commit that you make, ``pre-commit`` will
4443
download and install the necessary hooks (a one off task). If anything in the
45-
commit would fail the hooks, the commit will be abandoned. For ``black`` and
46-
``isort``, any necessary changes will be made automatically, but not staged.
44+
commit would fail the hooks, the commit will be abandoned. For ``ruff``, any
45+
necessary changes will be made automatically, but not staged.
4746
Review the changes, and then re-stage and commit again.
4847

4948
Using ``pre-commit`` ensures that code that would fail in QA does not make it
5049
into a commit in the first place, and will save you time in the long run. You
5150
can also (largely) stop worrying about code style, although you should always
52-
check how the code looks after ``black`` has formatted it, and think if there
51+
check how the code looks after ``ruff`` has formatted it, and think if there
5352
is a better way to structure the code so that it is more readable.
5453

5554
Documentation

0 commit comments

Comments
 (0)