From 10ae841db3338903fadd0fee08f683e7952a9a40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Honza=20Kr=C3=A1l?= Date: Sat, 23 Nov 2013 19:34:54 +0100 Subject: [PATCH] Add a not on the optional test client override to CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c488ab34..6567769e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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