Skip to content

Commit

Permalink
docs: add git submodule init
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
JP-Ellis committed Nov 15, 2023
1 parent 4aa33de commit edd6856
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit edd6856

Please sign in to comment.