Skip to content

Commit a402a10

Browse files
authored
[Docs] Update repo documents (#417) (#422)
* Add missing contributions and license files to this repository * Improve readme with license and notice links
1 parent d896aa7 commit a402a10

File tree

4 files changed

+40
-1
lines changed

4 files changed

+40
-1
lines changed

CODE_OF_CONDUCT.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
303 See Other
2+
3+
Location: https://www.elastic.co/community/codeofconduct

CONTRIBUTING.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing
2+
3+
The Elasticsearch Go client is open source and we love to receive contributions from our community.
4+
5+
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code.
6+
7+
## Sign the Contributor License Agreement
8+
9+
We do ask that you sign the [Contiributor License Agreement](https://www.elastic.co/contributor-agreement)
10+
before we can accept pull requests from you.
11+
12+
## Development
13+
14+
### Prerequisites
15+
16+
You need at least Go 1.13 to build the project.
17+
18+
Docker is used for some tests to spawn an Elasticsearch server.
19+
20+
### Project structure
21+
22+
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.
23+
24+
25+
26+
### Before you open a PR
27+
28+
Please run the tests locally with `make test` and make sure everything is in order.
29+
30+
If your changes address the generator, you can run the integration with the following command:
31+
32+
`TEST_SUITE=free STACK_VERSION=8.0.0-SNAPSHOT WORKSPACE=/tmp/workspace/$STACK_VERSION .ci/run-tests`
33+
34+
TEST_SUITE can either be `free` or `platinum`, STACK_VERSION reflects the targeted Elasticsearch version of the client.

NOTICE

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Elasticsearch Go Client
2+
Copyright 2021 Elasticsearch B.V.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -375,4 +375,4 @@ The **[`_examples`](./_examples)** folder contains a number of recipes and compr
375375

376376
## License
377377

378-
(c) 2019 Elasticsearch. Licensed under the Apache License, Version 2.0.
378+
This software is licensed under the [Apache 2 license](./LICENSE). See [NOTICE](./NOTICE).

0 commit comments

Comments
 (0)