Skip to content

Commit 27bbec0

Browse files
llilyyjasontedor
authored andcommitted
Update contributing docs to use the Gradle wrapper
This commit updates the contributing docs to reference the introduction of the Gradle wrapper. Relates #28103
1 parent 38701fb commit 27bbec0

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -99,13 +99,13 @@ We support development in the Eclipse and IntelliJ IDEs. For Eclipse, the
9999
minimum version that we support is [Eclipse Oxygen][eclipse] (version 4.7). For
100100
IntelliJ, the minimum version that we support is [IntelliJ 2017.2][intellij].
101101

102-
Eclipse users can automatically configure their IDE: `gradle eclipse`
102+
Eclipse users can automatically configure their IDE: `./gradlew eclipse`
103103
then `File: Import: Existing Projects into Workspace`. Select the
104104
option `Search for nested projects`. Additionally you will want to
105105
ensure that Eclipse is using 2048m of heap by modifying `eclipse.ini`
106106
accordingly to avoid GC overhead errors.
107107

108-
IntelliJ users can automatically configure their IDE: `gradle idea`
108+
IntelliJ users can automatically configure their IDE: `./gradlew idea`
109109
then `File->New Project From Existing Sources`. Point to the root of
110110
the source directory, select
111111
`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
123123
classpath](https://github.com/elastic/elasticsearch/issues/14348) if that is
124124
reported as a source of jar hell.
125125

126-
To run an instance of elasticsearch from the source code run `gradle run`
126+
To run an instance of elasticsearch from the source code run `./gradlew run`
127127

128128
The Elasticsearch codebase makes heavy use of Java `assert`s and the
129129
test runner requires that assertions be enabled within the JVM. This
@@ -151,15 +151,15 @@ To create a distribution from the source, simply run:
151151

152152
```sh
153153
cd elasticsearch/
154-
gradle assemble
154+
./gradlew assemble
155155
```
156156

157157
You will find the newly built packages under: `./distribution/(deb|rpm|tar|zip)/build/distributions/`.
158158

159159
Before submitting your changes, run the test suite to make sure that nothing is broken, with:
160160

161161
```sh
162-
gradle check
162+
./gradlew check
163163
```
164164

165165
Contributing as part of a class
@@ -187,7 +187,7 @@ code review process because it wastes our time.
187187
* We don't have the capacity to absorb an entire class full of new contributors,
188188
especially when they are unlikely to become long time contributors.
189189

190-
Finally, we require that you run `gradle check` before submitting a
190+
Finally, we require that you run `./gradlew check` before submitting a
191191
non-documentation contribution. This is mentioned above, but it is worth
192192
repeating in this section because it has come up in this context.
193193

0 commit comments

Comments
 (0)