Create message Pact docs

Open
#1,266 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 9 days

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

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.

Description

area:documentation difficulty:easy type:chore
Have you 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.
Dominant language
Python
Stars
689
Forks
147
Avg merge
8d 11h
Merged PRs (30d)
27

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pact-foundation/pact-python

All issues in pact-foundation/pact-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.