Skip to content

Commit

Permalink
Update pre-commit docs (#206)
Browse files Browse the repository at this point in the history
  • Loading branch information
ashwinvaidya17 committed Apr 11, 2022
1 parent c16d14c commit 2c71f97
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/source/guides/using_pre_commit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
First of all, you will need to install development requirements. This will also install the pre-commit pip package
in your python environment

```pip install -r requirements_dev.txt```
```pip install -r requirements/dev.txt```

Then, install pre-commit hooks using the following command:

Expand All @@ -17,3 +17,7 @@ In some cases it might be desired to commit your changes even though some of the
```git commit -m 'WIP commit' --no-verify```

When doing so, please make sure to revisit the issues at a later time. A good way to check if all issues have been addressed before making an MR is to run tox.

Apart from tox, you can also run `pre-commit` on all the files to check formatting and style issues. To do this you can use

```pre-commit run --all```

0 comments on commit 2c71f97

Please sign in to comment.