docs: document how to run the test suite locally
メンテナーはふだん 2 日以内に返信
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 78/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- python
- 領域
- documentation, testing
調査の方向性
Contributor向けまたは開発ドキュメントから始め、続いてリポジトリのpytest設定とCI workflowを調べて、確立されているコマンドと依存関係のセットアップを確認します。依存関係のインストール、pytestの全体実行と対象を絞った実行、テストがスキップされる理由、CIのテスト設定が存在する場所を文書化します。新しいcontributorが関連するチェックをローカルで再現できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Problem
When working on a test contribution, I had to inspect the repository's test configuration and CI workflow to determine how to run the same test suite locally.
The project has an established pytest-based test suite, but as a new contributor, I initially had to investigate the repository configuration to understand the expected local testing workflow.
Proposed documentation
Add a short section to the contributor/development documentation explaining:
- how to install the test dependencies
- how to run the complete test suite
- how to run a specific test file
- how to run a focused test using pytest's
-koption - why some tests may be skipped
- where contributors can find the CI test configuration
Who this is for
This is intended for new contributors making their first test-related change who need to verify their changes locally before opening a pull request.
Why I am proposing this
This is based on a real point where I was confused during my test contribution. I had to inspect the project's test configuration and CI workflow to understand how local pytest execution related to the automated checks on a pull request.
- 主要言語
- Python
- スター
- 761
- フォーク
- 185
- 平均マージ
- 4日 3時間
- マージ済み PR（30日）
- 7
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
python-humanize/humanize のほかの issue
-
docs: document the contributor testing workflow対応中かも @harmehak0173 が 1 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
python-humanize/humanize#438 ·
メンテナーはふだん 2 日以内に返信
-
intcomma returns scientific notation for large floats対応中かも @TheNetherWatcher が 6 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
python-humanize/humanize#431 ·
メンテナーはふだん 2 日以内に返信
-
metric() adds a digit when a value rounds into quetta対応中かも @SashaMIT が 7 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
python-humanize/humanize#423 ·
メンテナーはふだん 2 日以内に返信
-
precisedelta() silently drops the sign of negative timedeltas対応中かも @Mukller が 45 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
python-humanize/humanize#379 ·
メンテナーはふだん 2 日以内に返信
-
`naturalsize()` raises `ValueError` for custom format strings with text対応中かも @Sanjays2402 が 69 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
python-humanize/humanize#366 ·
メンテナーはふだん 2 日以内に返信
python-humanize/humanize の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
Graphify-Labs/graphify#4241 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
-
DeviceTrackerオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 63/100
XiaoMi/ha_xiaomi_home#1821 ·
メンテナーはふだん 1 日以内に返信
-
Maven path-index: "Ambiguous or noncanonical artifact path" error does not report the offending pathオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
pulp/pulp_maven#524 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信