mocobeta commented on a change in pull request #771: URL: https://github.com/apache/lucene/pull/771#discussion_r836967733
########## File path: CONTRIBUTING.md ########## @@ -0,0 +1,128 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + +# Contributing to Lucene Guide + +## Working with Code + +### Getting the source code + +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 + +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. + +### 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. + +Run "./gradlew help", this will show the main tasks that can be executed to show help sub-topics. + +If you want to build Lucene, type: + +``` +./gradlew assemble +``` + +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. + +`./gradlew check` will assemble Lucene and run all validation + tasks (including tests). + +`./gradlew help` will print a list of help guides that introduce and explain + various parts of the build system, including typical workflow tasks. + +If you want to just build the documentation, type: + +``` +./gradlew documentation +``` + +### Unit tests + +Please make sure that all unit tests succeed before constructing your patch: `./gradlew test`. + +To run a single test case from the lucene/core directory in your working copy: `./gradlew -p lucene/core test --tests NameOfYourUnitTest`. Run `./gradlew helpTests` to get more information about running tests. + +In case your contribution fixes a bug, please create a new test case that fails before your fix, to show the presence of the bug and ensure it never re-occurs. A test case showing the presence of a bug is also a good contribution by itself. + +### Precommit + +Please run `./gradlew precommit` to identify problems that should be addressed before you contribute your changes. Review comment: this section was removed. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
