Skip to content

Commit 9359a9d

Browse files
authored
Update contributing guide: autocrlf and build dependencies (apache#12963)
1 parent f6b2006 commit 9359a9d

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,21 @@ First of all, you need the Lucene source code.
2525

2626
Get the source code using: `git clone https://github.com/apache/lucene`
2727

28-
### Notes for required Java version
28+
Please note that it is important to preserve the files' original line breaks - some of them have their checksums verified during build.
29+
If you are using Windows you might want to override the default Git configuration when cloning the repository:
30+
`git clone --config core.autocrlf=false https://github.com/apache/lucene`
31+
32+
### Pre-requisites
2933

3034
Be sure that you are using an appropriate version of the JDK. Please check [README](./README.md) for the required JDK version for current main branch.
3135

36+
Some build tasks (in particular `./gradlew check`) require Perl and Python 3.
37+
3238
### Building with Gradle
3339

3440
Lucene uses [Gradle](https://gradle.org/) for build control. Gradle is itself Java-based and may be incompatible with newer Java versions; you can still build and test Lucene with these Java releases, see [jvms.txt](./help/jvms.txt) for more information.
3541

36-
NOTE: DO NOT use the `gradle` command that is perhaps installed on your machine. This may result in using a different gradle version than the project requires and this is known to lead to very cryptic errors. The "gradle wrapper" (gradlew script) does everything required to build the project from scratch: it downloads the correct version of gradle, sets up sane local configurations and is tested on multiple environments.
42+
NOTE: DO NOT use the `gradle` command that is perhaps installed on your machine. This may result in using a different gradle version than the project requires and this is known to lead to very cryptic errors. The "gradle wrapper" (`gradlew` script) does everything required to build the project from scratch: it downloads the correct version of gradle, sets up sane local configurations and is tested on multiple environments.
3743

3844
The first time you run gradlew, it will create a file "gradle.properties" that contains machine-specific settings. Normally you can use this file as-is, but it can be modified if necessary.
3945

0 commit comments

Comments
 (0)