pact-foundation / pact-foundation/pact-python
Create message Pact docs
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
To add a new section to the docs documenting how Pact Python can be used to verify messages, both synchronous and asynchronous.
The docs should build on top of the existing consumer and provider docs.
Motivation
To help with the adoption of message verification using Pact Python
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 locating the existing consumer and provider documentation sections and review how they are structured. Add a new section covering both synchronous and asynchronous message verification with Pact Python; done means the documentation builds successfully and explains both workflows clearly.
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
- 45/100