Add a not on the optional test client override to CONTRIBUTING.md

2013-11-23 19:34:54 +01:00
parent 911817d514
commit 10ae841db3
1 changed files with 7 additions and 0 deletions
@@ -24,6 +24,13 @@ The process for contributing to any of the Elasticsearch repositories is similar
    python setup.py test
    ````

+   If your changes require special configuration of the client you can create a
+   `test_elasticsearch/local.py` file containing a `get_client` with the same
+   signature as the client itself (`hosts, **kwargs` will do) and returns a client
+   instance. This function will be used for any tests running against ES and will
+   be passed all the parameters that would otherwise be used to construct the
+   client instance directly.
+
 3. Rebase your changes.
   Update your local repository with the most recent code from the main
   elasticsearch-py repository, and rebase your branch on top of the latest master