From edd6856e7f6056370646a93b6f52241be44d6b87 Mon Sep 17 00:00:00 2001 From: JP-Ellis Date: Wed, 15 Nov 2023 16:42:45 +1100 Subject: [PATCH] docs: add git submodule init With the addition of a git submodule for the compatibility suite, the contributing docs needed to be updated to ensure the additional step is documented. Signed-off-by: JP-Ellis --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b6ca493c8..5f1de75e09 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,7 +99,7 @@ You can also try using the new [github.dev](https://github.dev/pact-foundation/p pipx install hatch ``` -3. After cloning the repository, run `hatch shell` in the root of the repository. This will install all dependencies in a Python virtual environment and then ensure that the virtual environment is activated. +3. After cloning the repository, run `hatch shell` in the root of the repository. This will install all dependencies in a Python virtual environment and then ensure that the virtual environment is activated. You will also need to run `git submodule init` if you want to run tests, as Pact Python makes use of the Pact Compability Suite. 4. To run tests, run `hatch run test` to make sure the test suite is working. You should also make sure the example works by running `hatch run example`. For the examples, you will have to make sure that you have Docker (or a suitable alternative) installed and running.