testcontainers / testcontainers/testcontainers-python
Docs: Improve docs with examples
オープン
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 2.3k
- フォーク
- 386
- 平均マージ
- 4時間 40分
- マージ済み PR（30日）
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、各メンテナンス対象モジュールのランディングページとドキュメントを読んで、現在の構成と不足している例を確認します。ランディングページと各モジュールに、pytestベースの例を含むPythonの使用例を追加します。例が要求された領域をカバーし、その流れを学んでいる人にとって理解しやすければ完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- docker, python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100