testcontainers / testcontainers/testcontainers-python
Docs: Improve docs with examples
未关闭
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 2.3k
- 派生
- 386
- 平均合并
- 4 小时 40 分钟
- 30 天内合并 PR
- 1
描述
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
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
首先阅读每个受维护模块的 landing page 和文档，以确定当前结构和缺失的示例。在 landing page 和各模块中添加 Python 使用示例，包括基于 pytest 的示例；当示例覆盖所要求的领域，并且对于正在学习该流程的人来说易于理解时，即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- docker, python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 冷清
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100