貢献する

重要

パッチの作成、バグの報告、プロジェクトのコーディングスタイルについてのヒントは、 Scrapy Contribution Docs を読んでください。

これらのドキュメントは、セットアップ方法とScrapydに貢献する方法を説明しています。

問題とバグの報告

問題は、GitHub上にあるScrapyプロジェクトの issue tracker で報告されるべきです。

テスト

テストは、 Twisted unit-testing framework を用いて実装されています。Scrapydはアプリケーション実行のテストに trial を使用しています。

テストの実行

全てのテストを実行するに、Scrapydソースコードのルートディレクトリに移動し、以下を実行します。

trial scrapyd

特定のテストを実行する場合(例えば tests/test_poller.py)、以下を使用します。

trial scrapyd.tests.test_poller

テストを書く

全ての機能(新機能やバグの修正を含む)には、期待通りに動作することを確認するためのテストケースが含まれるべきです。ですから、パッチができるだけ早く受けいれられるために、パッチにはテストを含めてください。

Scrapydは scrapyd/tests ディレクトリにあるユニットテストを使用します。通常、テストモジュールの名前はテスト対象モジュールの完全なパスに似ています。例えばスケジューラのコードは以下です。

scrapyd.scheduler

そしてそのユニットテストは以下です。

scrapyd/tests/test_scheduler.py

ローカルへインストールする

ローカルで編集されたバージョンのScrapydを実行する、またはテストする目的でシステムにインストールするには、プロジェクトのルートで以下を実行します。

pip install -e .