Debian Codegraph @

CONTRIBUTING.md

raw
1 # How to contribute
2
3 Elastic is an open-source project and we are looking forward to each
4 contribution.
5
6 Notice that while the [official Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) is rather good, it is a high-level
7 overview of the features of Elasticsearch. However, Elastic tries to resemble
8 the Java API of Elasticsearch which you can find [on GitHub](https://github.com/elastic/elasticsearch).
9
10 This explains why you might think that some options are strange or missing
11 in Elastic, while often they're just different. Please check the Java API first.
12
13 Having said that: Elasticsearch is moving fast and it might be very likely
14 that we missed some features or changes. Feel free to change that.
15
16 ## Your Pull Request
17
18 To make it easy to review and understand your changes, please keep the
19 following things in mind before submitting your pull request:
20
21 * You compared the existing implemenation with the Java API, did you?
22 * Please work on the latest possible state of `olivere/elastic`.
23 Use `release-branch.v2` for targeting Elasticsearch 1.x and
24 `release-branch.v3` for targeting 2.x.
25 * Create a branch dedicated to your change.
26 * If possible, write a test case which confirms your change.
27 * Make sure your changes and your tests work with all recent versions of
28 Elasticsearch. We currently support Elasticsearch 1.7.x in the
29 release-branch.v2 and Elasticsearch 2.x in the release-branch.v3.
30 * Test your changes before creating a pull request (`go test ./...`).
31 * Don't mix several features or bug fixes in one pull request.
32 * Create a meaningful commit message.
33 * Explain your change, e.g. provide a link to the issue you are fixing and
34 probably a link to the Elasticsearch documentation and/or source code.
35 * Format your source with `go fmt`.
36
37 ## Additional Resources
38
39 * [GitHub documentation](http://help.github.com/)
40 * [GitHub pull request documentation](http://help.github.com/send-pull-requests/)