-
Notifications
You must be signed in to change notification settings - Fork 25k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a quick tour of the project to CONTRIBUTING #30187
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -41,7 +41,7 @@ We enjoy working with contributors to get their code accepted. There are many ap | |
Note that it is unlikely the project will merge refactors for the sake of refactoring. These | ||
types of pull requests have a high cost to maintainers in reviewing and testing with little | ||
to no tangible benefit. This especially includes changes generated by tools. For example, | ||
converting all generic interface instances to use the diamond operator. | ||
converting all generic interface instances to use the diamond operator. | ||
|
||
The process for contributing to any of the [Elastic repositories](https://github.com/elastic/) is similar. Details for individual projects can be found below. | ||
|
||
|
@@ -209,6 +209,95 @@ Before submitting your changes, run the test suite to make sure that nothing is | |
./gradlew check | ||
``` | ||
|
||
### Project layout | ||
|
||
This repository is split into many top level directories. The most important | ||
ones are | ||
|
||
#### `docs` | ||
Documentation for the project. | ||
|
||
#### `distribution` | ||
Builds our tar and zip archives and our rpm and deb packages. | ||
|
||
#### `libs` | ||
Libraries used to build other parts of the project. These are meant to be | ||
internal rather than general purpose. We have no plans to | ||
[semver](https://semver.org/) their APIs or accept feature requests for them. | ||
We publish them to maven central because they are dependencies of our plugin | ||
test framework, high level rest client, and jdbc driver but they really aren't | ||
general purpose enough to *belong* in maven central. We're still working out | ||
what to do here.... | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe ommit the dots. |
||
|
||
#### `modules` | ||
Features that are shipped with Elasticsearch by default but are not built in to | ||
the server. We typically separate features from the server because they require | ||
permissions that we don't believe *all* of Elasticsearch should have or because | ||
they depend on libraries that we don't believe *all* of Elasticsearch should | ||
depend on. | ||
|
||
For example, reindex requires the `connect` permission so it can perform | ||
reindex-from-remote but we don't believe that the *all* of Elasticsearch should | ||
have the "connect". For another example, Painless is implemented using antlr4 | ||
and asm and we don't believe that *all* of Elasticsearch should have access to | ||
them. | ||
|
||
#### `plugins` | ||
Officially supported plugins to Elasticsearch. We decide that a feature should | ||
be a plugin rather than shipped as a module because we feel that it is only | ||
important to a subset of users, especially if it requires extra dependencies. | ||
|
||
The canonical example of this is the ICU analysis plugin. It is important for | ||
folks who want the fairly language neutral ICU analyzer but the library to | ||
implement the analyzer is 11MB so we don't ship it with Elasticsearch by | ||
default. | ||
|
||
Another example is the `discovery-gce` plugin. It is *vital* to folks running | ||
in [GCP](https://cloud.google.com/) but useless otherwise and it depends on a | ||
dozen extra jars. | ||
|
||
#### `qa` | ||
Honestly this is kind of in flux and we're not 100% sure where we'll end up. | ||
Right now the directory contains | ||
* Tests that require multiple modules or plugins to work | ||
* Tests that form a cluster made up of multiple versions of Elasticsearch like | ||
full cluster restart, rolling restarts, and mixed version tests | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When rendered e.g in Atom, the indentations make these line appear in boxes in a fixed font, just like code examples. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not at all. VSCode's preview doesn't do that. I'll remove the indentation anyway. |
||
* Tests that test the Elasticsearch clients in "interesting" places like the | ||
`wildfly` project. | ||
* Tests that test Elasticsearch in funny configurations like with ingest | ||
disabled | ||
* Tests that need to do strange things like install plugins that thrown | ||
uncaught `Throwable`s or add a shutdown hook | ||
But we're not convinced that all of these things *belong* in the qa directory. | ||
We're fairly sure that "tests that require multiple modules or plugins to work" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why the quotes? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. They made sense in my head the first time. They don't make sense this time around though. Dropping them. |
||
should just pick a "home" plugin. We're fairly sure that the multi-version | ||
tests *do* belong in qa. Beyond that, we're not sure. If you want to add a new | ||
thing qa module, ask around and you'll get several opinions. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Something missing "a new thing qa module" There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe "ask around" needs some more clarification? For internal users this would be Slack, but otherwise probably Github? The Forum? Not sure if we have a prefered point of contact. If somebody wants to add sth. its probably a PR anyway? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'll reword it mentioning PRs, yeah. |
||
|
||
#### `server` | ||
The server component of Elasticsearch that contains all of the modules and | ||
plugins. Right now things like the high level rest client depend on the server | ||
but we'd like to fix that in the future. | ||
|
||
#### `test` | ||
Our test framework and test fixtures. We use the test framework for testing the | ||
server, the plugins, and modules, and pretty much everything else. We publish | ||
the test framework so folks who develope Elasticsearch plugins can use it to | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I just learned sth. new about develope vs. develop (https://en.wiktionary.org/wiki/develope) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That was just a spelling mistake! |
||
test the plugins. The test fixtures are external processes that we start before | ||
running specific tests that rely on them. | ||
|
||
For example, we have an hdfs test that uses mini-hdfs to test our | ||
repository-hdfs plugin. | ||
|
||
#### `x-pack` | ||
Commercially licensed code that integrates with the rest of Elasticsearch. The | ||
`docs` subdirectory functions just like the top level `docs` subdirectory and | ||
the `qa` subdirectory functions just like the top level `qa` subdirectory. The | ||
`plugin` subdirectory contains the x-pack module which runs inside the | ||
Elasticsearch process. The `transport-client` subdirectory contains extensions | ||
to Elasticsearch's standard transport client to work properly with x-pack. | ||
|
||
|
||
Contributing as part of a class | ||
------------------------------- | ||
In general Elasticsearch is happy to accept contributions that were created as | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"consists of" vs. "split"? Maybe not that important.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like to pick shorter words.