testcontainers / testcontainers/testcontainers-python
Docs: Improve docs with examples
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.3k
- Forks
- 386
- Avg merge
- 4h 40m
- Merged PRs (30d)
- 1
Description
What are you trying to do?
I am trying to implement testcontainer in python but struggling to understand the flow
Why should it be done this way?
- Add examples in the landing page
- Examples for each mantained module
- Examples with pytest
Extra Info
I will try to do a PR
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 landing page and documentation for each maintained module to identify the current structure and missing examples. Add Python usage examples, including pytest-based examples, across the landing page and modules; done means the examples cover the requested areas and are understandable for someone learning the flow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100