-
Notifications
You must be signed in to change notification settings - Fork 623
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add missing contributions and license files to this repository * Improve readme with license and notice links
- Loading branch information
1 parent
93c3ed8
commit 2c5caad
Showing
4 changed files
with
40 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
303 See Other | ||
|
||
Location: https://www.elastic.co/community/codeofconduct |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Contributing | ||
|
||
The Elasticsearch Go client is open source and we love to receive contributions from our community. | ||
|
||
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code. | ||
|
||
## Sign the Contributor License Agreement | ||
|
||
We do ask that you sign the [Contiributor License Agreement](https://www.elastic.co/contributor-agreement) | ||
before we can accept pull requests from you. | ||
|
||
## Development | ||
|
||
### Prerequisites | ||
|
||
You need at least Go 1.13 to build the project. | ||
|
||
Docker is used for some tests to spawn an Elasticsearch server. | ||
|
||
### Project structure | ||
|
||
The code for each API lives in individual files in the `esapi` subfolder, this code is entirely generated by the subproject located in the `internal/build` folder. | ||
|
||
|
||
|
||
### Before you open a PR | ||
|
||
Please run the tests locally with `make test` and make sure everything is in order. | ||
|
||
If your changes address the generator, you can run the integration with the following command: | ||
|
||
`TEST_SUITE=free STACK_VERSION=8.0.0-SNAPSHOT WORKSPACE=/tmp/workspace/$STACK_VERSION .ci/run-tests` | ||
|
||
TEST_SUITE can either be `free` or `platinum`, STACK_VERSION reflects the targeted Elasticsearch version of the client. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
Elasticsearch Go Client | ||
Copyright 2021 Elasticsearch B.V. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters