diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 92a7853fe..5e9d6ce1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,7 +52,7 @@ source venv/bin/activate pip install --upgrade pip # Install Haystack in editable mode -pip install -e '.[all]' +pip install -e '.[dev]' ``` This will install all the dependencies you need to work on the codebase, plus testing and formatting dependencies. @@ -60,13 +60,13 @@ This will install all the dependencies you need to work on the codebase, plus te Last, install the pre-commit hooks with: ```bash -pre-commit install --hook-type pre-push +pre-commit install ``` -This utility will run some tasks right before all `git push` operations. From now on, your `git push` output for Haystack should look something like this: +This utility will run some tasks right before all `git commit` operations. From now on, your `git commit` output for Haystack should look something like this: ``` -> git push +> git commit -m "test" check python ast.....................................(no files to check)Skipped check json...........................................(no files to check)Skipped check yaml...............................................................Passed @@ -80,17 +80,12 @@ don't commit to branch...................................................Passed pretty format json...................................(no files to check)Skipped black................................................(no files to check)Skipped Update API documentation (slow)..........................................Passed -Enumerating objects: 14, done. -Counting objects: 100% (14/14), done. -Delta compression using up to 16 threads -Compressing objects: 100% (12/12), done. -Writing objects: 100% (12/12), 1.06 KiB | 1.06 MiB/s, done. -Total 12 (delta 8), reused 0 (delta 0), pack-reused 0 -remote: Resolving deltas: 100% (8/8), completed with 2 local objects. -To github.com:deepset-ai/haystack.git - 801be454..6fddb35f my-branch -> my-branch +[my-branch bc7f4af7] test + 1 files changed, 1 insertions(+), 0 deletions(-) ``` +Note: If you prefer you can run this hook before `git push` instead of `git commit`. To do so, install the hook with `pre-commit install --hook-type pre-push` + Note: pre-commit hooks might fail. If that happens to you and you can't understand why, please do the following: - Ask for help by opening an issue or reaching out on our Slack channel. We usually give some feedback within a day for most questions. - As the last resort, if you are desperate and everything failed, ask Git to skip the hook with `git commit --no-verify`. This command will suspend all pre-commit hooks and let you push in all cases. The CI might fail, but at that point we will be able to help. @@ -113,7 +108,7 @@ If all goes well, at the bottom of your PR page you should see something like th ![Successful CI](docs/img/ci-success.png) -If you see some red checks (like the following), then something didn't work, and action is needed from your side. +If you see some red checks (like the following), then something didn't work, and action is needed from your side. ![Failed CI](docs/img/ci-failure-example.png)