honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update contributing docs to use the Gradle wrapper 

This commit updates the contributing docs to reference the introduction
of the Gradle wrapper.

Relates #28103
This commit is contained in:
hyeonyoung na 2018-01-06 02:16:15 +09:00 committed by Jason Tedor
parent 38701fb6ee
commit 27bbec0c19
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -99,13 +99,13 @@ We support development in the Eclipse and IntelliJ IDEs. For Eclipse, the
minimum version that we support is [Eclipse Oxygen][eclipse] (version 4.7). For
IntelliJ, the minimum version that we support is [IntelliJ 2017.2][intellij].
Eclipse users can automatically configure their IDE: `gradle eclipse`
Eclipse users can automatically configure their IDE: `./gradlew eclipse`
then `File: Import: Existing Projects into Workspace`. Select the
option `Search for nested projects`. Additionally you will want to
ensure that Eclipse is using 2048m of heap by modifying `eclipse.ini`
accordingly to avoid GC overhead errors.
IntelliJ users can automatically configure their IDE: `gradle idea`
IntelliJ users can automatically configure their IDE: `./gradlew idea`
then `File->New Project From Existing Sources`. Point to the root of
the source directory, select
`Import project from external model->Gradle`, enable
@ -123,7 +123,7 @@ restart of IDEA). For IDEA 2017.3 and above, in addition to the JVM option, you
classpath](https://github.com/elastic/elasticsearch/issues/14348) if that is
reported as a source of jar hell.
To run an instance of elasticsearch from the source code run `gradle run`
To run an instance of elasticsearch from the source code run `./gradlew run`
The Elasticsearch codebase makes heavy use of Java `assert`s and the
test runner requires that assertions be enabled within the JVM. This
@ -151,7 +151,7 @@ To create a distribution from the source, simply run:
```sh
cd elasticsearch/
gradle assemble
./gradlew assemble
```
You will find the newly built packages under: `./distribution/(deb|rpm|tar|zip)/build/distributions/`.
@ -159,7 +159,7 @@ You will find the newly built packages under: `./distribution/(deb|rpm|tar|zip)/
Before submitting your changes, run the test suite to make sure that nothing is broken, with:
```sh
gradle check
./gradlew check
```
Contributing as part of a class
@ -187,7 +187,7 @@ code review process because it wastes our time.
* We don't have the capacity to absorb an entire class full of new contributors,
especially when they are unlikely to become long time contributors.
Finally, we require that you run `gradle check` before submitting a
Finally, we require that you run `./gradlew check` before submitting a
non-documentation contribution. This is mentioned above, but it is worth
repeating in this section because it has come up in this context.