testcontainers / testcontainers/testcontainers-python
Docs: generate Sphinx documentation with all (public API) classes and members.
オープン
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 2.3k
- フォーク
- 386
- 平均マージ
- 4時間 40分
- マージ済み PR（30日）
- 1
説明
low priority.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、リポジトリの Sphinx ドキュメント設定と Python 公開 API のエントリポイントを特定します。issue ではファイルやテストは指定されていません。すべての公開クラスとメンバーをどのように含めるべきかを判断し、生成された Sphinx ドキュメントがそれらを一貫して網羅していることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 20/100