Skip to content

Commit 249bb53

Browse files
committed
Added chapter about development to the subproject's READMEs
1 parent 7885726 commit 249bb53

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

elasticsearch-api/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,22 @@ mash.facets.tags.terms.first
155155
# => #<Hashie::Mash count=3 term="z">
156156
```
157157

158+
## Development
159+
160+
To work on the code, clone and bootstrap the main repository first --
161+
please see instructions in the main [README](../README.md#development).
162+
163+
To run tests, launch a testing cluster -- again, see instructions
164+
in the main [README](../README.md#development) -- and use the Rake tasks:
165+
166+
```
167+
time rake test:unit
168+
time rake test:integration
169+
```
170+
171+
Unit tests have to use Ruby 1.8 compatible syntax, integration tests
172+
can use Ruby 2.x syntax and features.
173+
158174
## License
159175

160176
This software is licensed under the Apache 2 license, quoted below.

elasticsearch-extensions/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,22 @@ or install it from a source code checkout:
161161
bundle install
162162
rake install
163163

164+
## Development
165+
166+
To work on the code, clone and bootstrap the main repository first --
167+
please see instructions in the main [README](../README.md#development).
168+
169+
To run tests, launch a testing cluster -- again, see instructions
170+
in the main [README](../README.md#development) -- and use the Rake tasks:
171+
172+
```
173+
time rake test:unit
174+
time rake test:integration
175+
```
176+
177+
Unit tests have to use Ruby 1.8 compatible syntax, integration tests
178+
can use Ruby 2.x syntax and features.
179+
164180
## License
165181

166182
This software is licensed under the Apache 2 license, quoted below.

elasticsearch-transport/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -374,6 +374,22 @@ Github's pull requests and issues are used to communicate, send bug reports and
374374
* The {Elasticsearch::Transport::Transport::Connections::Selector::Base} implementations allow to choose connections
375375
from the pool, eg. in a round-robin or random fashion. You can implement your own selector strategy.
376376

377+
## Development
378+
379+
To work on the code, clone and bootstrap the main repository first --
380+
please see instructions in the main [README](../README.md#development).
381+
382+
To run tests, launch a testing cluster -- again, see instructions
383+
in the main [README](../README.md#development) -- and use the Rake tasks:
384+
385+
```
386+
time rake test:unit
387+
time rake test:integration
388+
```
389+
390+
Unit tests have to use Ruby 1.8 compatible syntax, integration tests
391+
can use Ruby 2.x syntax and features.
392+
377393
## License
378394

379395
This software is licensed under the Apache 2 license, quoted below.

0 commit comments

Comments
 (0)