testcontainers / testcontainers/testcontainers-python
Docs: add doctests to mkdocs
オープン
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 2.3k
- フォーク
- 386
- 平均マージ
- 4時間 40分
- マージ済み PR（30日）
- 1
説明
high priority!
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、リポジトリの MkDocs 設定と既存の Python ドキュメントを確認し、どの例が対象範囲に含まれるかを判断します。プロジェクトでドキュメント化されているドキュメントまたはテストのコマンドを実行し、選択した例が MkDocs 上で doctests として正常に実行されれば、作業は完了したものとします。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 20/100