Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 2.26 KB
Raw

Contributing to Elasticsearch Ruby

To work on the code, clone and bootstrap the project first:

git clone https://github.com/elasticsearch/elasticsearch-ruby.git
cd elasticsearch-ruby/
bundle exec rake bundle

This will run bundle install in all subprojects.

To run the tests, you need to start a testing cluster on port 9200. We suggest using Docker, there's a Rake task to start a testing cluster in a Docker container:

rake docker:start[version]

E.g.: rake docker:start[7.x-SNAPSHOT]. To start the container with Platinum, pass it in as a parameter: rake docker:start[7.x-SNAPSHOT,xpack].

As mentioned, the tests will atempt to run against http://localhost:9200 by default. We provide the Docker task for the test cluster and recommend using it. But you can provide a different test server of your own. If you're using a different host or port, set the TEST_ES_SERVER environment variable with the server information. E.g.:

$ TEST_ES_SERVER='http://localhost:9250' be rake test:client

To run all the tests in all the subprojects, use the Rake task:

time rake test:client

The process for contributing to any of the Elasticsearch repositories is similar:

  1. It is best to do your work in a separate Git branch. This makes it easier to synchronise your changes with rebase.

  2. Make sure your changes don't break any existing tests, and that you add tests for both bugfixes and new functionality. Examine the coverage report generated by running COVERAGE=true rake test:all.

  3. Sign the contributor license agreement. Please make sure you have signed the Contributor License Agreement. We are not asking you to assign copyright to us, but to give us the right to distribute your code without restriction. We ask this of all contributors in order to assure our users of the origin and continuing existence of the code. You only need to sign the CLA once.

  4. Submit a pull request. Push your local changes to your forked copy of the repository and submit a pull request. In the pull request, describe what your changes do and mention the number of the issue where discussion has taken place, eg “Closes #123″.