(lucene) branch main updated: Update contributing guide: autocrlf and build dependencies (#12963)

[dw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dweiss pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/lucene.git


The following commit(s) were added to refs/heads/main by this push:
     new 9359a9dcffc Update contributing guide: autocrlf and build dependencies (#12963)
9359a9dcffc is described below

commit 9359a9dcffc566d6cdcfc8edba0077ff52ef0f41
Author: sabi0 <2s...@gmail.com>
AuthorDate: Fri Dec 22 09:28:53 2023 +0100

    Update contributing guide: autocrlf and build dependencies (#12963)
---
 CONTRIBUTING.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 49a14e1fae5..d568b18def4 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -25,15 +25,21 @@ First of all, you need the Lucene source code.
 
 Get the source code using: `git clone https://github.com/apache/lucene`
 
-### Notes for required Java version
+Please note that it is important to preserve the files' original line breaks - some of them have their checksums verified during build.
+If you are using Windows you might want to override the default Git configuration when cloning the repository:
+`git clone --config core.autocrlf=false https://github.com/apache/lucene`
+
+### Pre-requisites
 
 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.
 
+Some build tasks (in particular `./gradlew check`) require Perl and Python 3.
+
 ### Building with Gradle
 
 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.
 
-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.
+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.
 
 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.