Skip to content

Commit

Permalink
Update contributing guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
domdfcoding committed Nov 11, 2020
1 parent 5d7e991 commit 20cf6ce
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 10 deletions.
9 changes: 4 additions & 5 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,16 @@ Install ``pre-commit`` with ``pip`` and install the git hook:
Coding style
--------------

`Yapf <https://github.com/google/yapf>`_ is used for code formatting, and `isort <https://timothycrosley.github.io/isort/>`_ is used to sort imports.
`yapf-isort <https://pypi.org/project/yapf-isort/>`_ is used for code formatting.

``yapf`` and ``isort`` can be run manually via ``pre-commit``:
It can be run manually via ``pre-commit``:

.. code-block:: bash
$ pre-commit run yapf -a
$ pre-commit run isort -a
$ pre-commit run yapf-isort -a
The complete autoformatting suite can be run with ``pre-commit``:
Or, to run the complete autoformatting suite:

.. code-block:: bash
Expand Down
9 changes: 4 additions & 5 deletions doc-source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,16 @@ Install ``pre-commit`` with ``pip`` and install the git hook:
Coding style
--------------

`Yapf <https://github.com/google/yapf>`_ is used for code formatting, and `isort <https://timothycrosley.github.io/isort/>`_ is used to sort imports.
`yapf-isort <https://pypi.org/project/yapf-isort/>`_ is used for code formatting.

``yapf`` and ``isort`` can be run manually via ``pre-commit``:
It can be run manually via ``pre-commit``:

.. prompt:: bash

pre-commit run yapf -a
pre-commit run isort -a
pre-commit run yapf-isort -a


The complete autoformatting suite can be run with ``pre-commit``:
Or, to run the complete autoformatting suite:

.. prompt:: bash

Expand Down

0 comments on commit 20cf6ce

Please sign in to comment.