pact-foundation / pact-python

Python version of Pact. Enables consumer driven contract testing, providing a mock service and DSL for the consumer project, and interaction playback and verification for the service provider project.
http://pact.io
MIT License
568 stars 137 forks source link

docs(CONTRIBUTING.md): update installation steps #687

Closed qmg-drettie closed 5 months ago

qmg-drettie commented 5 months ago

adds step to patch the compatibility suite in order for tests to pass

:airplane: Pre-flight checklist

:memo: Summary

adds step to patch the compatibility suite in order for tests to pass

:rotating_light: Breaking Changes

:fire: Motivation

Cloned the repo for the first time and tried to run tests but some are failing. I found that the patch command is running within the github actions workflow to make the tests pass.

:hammer: Test Plan

:link: Related issues/PRs

JP-Ellis commented 5 months ago

Thanks! It was entirely an oversight on my part. The patch is temporary and will eventually be merged upstream; however, until such time, it is definitely better to make sure the docs are up to date!