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

Add pre-commit hooks to this repo #4

Closed
wants to merge 13 commits into from
Prev Previous commit
Next Next commit
Update Contributing.md
  • Loading branch information
anakin87 committed Sep 20, 2022
commit 6ea2bcdf19bd847e09c3928430452afad21d05ba
2 changes: 1 addition & 1 deletion Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ All of the Haystack tutorials live in the `tutorials` folder in this repo. Each
Here's what you need to do to add or edit tutorials 👇:

1. Prepare your environment:
- Install the Python requirements with `pip install requirements.txt`
- Install the Python requirements with `pip install -r requirements.txt`
- Install the pre-commit hooks with `pre-commit install`. This utility will run some formatting/checking
tasks right before all git commit operations.
2. If you're creating a new tutorial, follow the [naming convention](#naming-convention-for-file-names) for file names.
Expand Down