Skip to content

Commit

Permalink
DOCS: add pre-commit hook instructions to contribution guide (#253)
Browse files Browse the repository at this point in the history
Co-authored-by: Konstantin Hemker <hemker.konstantin@bcg.com>
  • Loading branch information
konst-int-i and Konstantin Hemker authored Mar 12, 2021
1 parent cb5a2a4 commit ecb4308
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions sphinx/source/contribution_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,19 @@ required development dependencies in the ``facet-develop`` environment.
conda activate facet-develop
Pre-commit hooks
~~~~~~~~~~~~~~~~~~~~
This project uses a number of pre-commit hooks such as black and flake8 to enforce
uniform coding standards in all commits. Before committing code, please run

.. code-block:: sh
pre-commit install
You can use ``pre-commit run`` to manually run the pre-commit hooks from the command
line.


Pytest
~~~~~~~~~~~~~~~
Run ``pytest tests/`` from the facet root folder or use the PyCharm test runner. To
Expand Down

0 comments on commit ecb4308

Please sign in to comment.