Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor update: Update pre-commit docs #206

Merged
merged 1 commit into from
Apr 11, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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```