Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-10513: Run `gradlew tidy` first (#808) 

Co-authored-by: Dawid Weiss <dawid.weiss@carrotsearch.com>
This commit is contained in:
Rich Bowen 2022-04-12 08:22:55 -04:00 committed by GitHub
parent eb2df13bba
commit e9789afb39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -59,7 +59,7 @@ If you want to just build the documentation, type:
### Checks
Please make sure that all unit tests and validations succeed before constructing your patch: `./gradlew check`.
Please make sure that all unit tests and validations succeed before constructing your patch: `./gradlew check`. If you've modified any sources, run `./gradlew tidy` to apply code formatting conventions automatically (see [help/formatting.txt](https://github.com/apache/lucene/blob/main/help/formatting.txt)).
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.

3
help/workflow.txt
View File

@ -3,6 +3,9 @@ Typical workflow and tasks
This shows some typical workflow gradle commands.
Ensure your changes are correctly formatted (run "gradlew :helpFormatting" for more):
gradlew tidy
Run tests on a module:
gradlew -p lucene/core test