Skip to content

Commit 754686c

Browse files
committed
Fixed version matrix + added Contributing section
1 parent 6db522f commit 754686c

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Table of Contents
4646
+ [Delete an index](#delete-an-index)
4747
+ [Create an index](#create-an-index)
4848
- [Unit Testing using Mock a Elastic Client](#unit-testing-using-mock-a-elastic-client)
49+
- [Contributing](#contributing)
4950
- [Wrap up](#wrap-up)
5051
* [Available Licenses](#available-licenses)
5152
+ [Contributions](#contributions)
@@ -62,27 +63,23 @@ Features
6263
- Option to use asynchronous future, which enables parallel execution of curl requests to multiple nodes
6364

6465

65-
**Note:** If you want to use [X-Pack](https://www.elastic.co/what-is/open-x-pack) API, you need to install an optional extension [elasticsearch/xpack](https://github.com/elastic/elasticsearch-x-pack-php).
66+
**Note:** [X-Pack](https://www.elastic.co/what-is/open-x-pack) endpoints are included from elasticsearch-php 7.7+.
6667

6768

6869
Version Matrix
6970
--------------
7071

7172
| Elasticsearch Version | Elasticsearch-PHP Branch |
7273
| --------------------- | ------------------------ |
73-
| >= 7.4 | 7.4 |
74-
| >= 7.2, < 7.4 | 7.2 |
75-
| >= 7.0, < 7.2 | 7.0 |
74+
| >= 7.x | 7.x |
7675
| >= 6.6, < 7.0 | 6.7.x |
7776
| >= 6.0, < 6.6 | 6.5.x |
7877
| >= 5.0, < 6.0 | 5.0 |
7978
| >= 2.0, < 5.0 | 1.0 or 2.0 |
8079
| >= 1.0, < 2.0 | 1.0 or 2.0 |
8180
| <= 0.90.x | 0.4 |
8281

83-
- If you are using Elasticsearch 7.4+ use Elasticsearch-PHP 7.4 branch.
84-
- If you are using Elasticsearch 7.2 to 7.3, use Elasticsearch-PHP 7.2 branch.
85-
- If you are using Elasticsearch 7.0 to 7.1, use Elasticsearch-PHP 7.0 branch.
82+
- If you are using Elasticsearch 7.x you can use use Elasticsearch-PHP 7.x branch
8683
- If you are using Elasticsearch 6.6 to 6.7, use Elasticsearch-PHP 6.7.x branch.
8784
- If you are using Elasticsearch 6.0 to 6.5, use Elasticsearch-PHP 6.5.x branch.
8885
- If you are using Elasticsearch 5.x, use Elasticsearch-PHP 5.0 branch.
@@ -434,6 +431,16 @@ $client = $builder->build();
434431
// Do a request and you'll get back the 'body' response above
435432
```
436433

434+
Contributing
435+
============
436+
437+
If you want to contribute to this project you need to subscribe a [Contributor Agreement](https://www.elastic.co/contributor-agreement).
438+
If you want to send a PR for version `Y` please use the `Y.x` branch. For instance if you want to send a PR for **elasticsearch-php 7** use the `7.x` branch.
439+
440+
Never send PR to `master` unless you want to contribute to the development version of the client (`master` represents the next major version).
441+
442+
Each PR should include a **unit test** using [PHPUnit](https://phpunit.de/). If you are not familiar with PHPUnit you can have a look at this [reference](https://phpunit.readthedocs.io/en/7.0/).
443+
437444
Wrap up
438445
=======
439446

0 commit comments

Comments
 (0)