pact-foundation / pact-foundation/pact-python
Update docs to show how to use webhooks
Open
Nobody has claimed this yet.
area:documentation
difficulty:easy
type:chore
- Dominant language
- Python
- Stars
- 684
- Forks
- 147
- Avg merge
- 3d 23h
- Merged PRs (30d)
- 12
Description
Have you read the Contributing Guidelines on issues?
- I have read the Contributing Guidelines on issues.
Description
Add docs to explain how to best use webhooks in Pact Python v3.
Motivation
The use of webhooks is a pretty important way to use Pact, which was not possible in v2.
Have you tried building it?
No response
Self-service
- I'd be willing to contribute this feature to Pact Python myself.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked Pact Broker webhooks documentation and locating the Pact Python v3 documentation entry point. Determine where webhook guidance belongs and document how webhooks should best be used with Pact Python v3. Done means the relevant docs clearly explain the supported webhook usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100