[lucene] branch main updated: LUCENE-10513: Run `gradlew tidy` first (#808)

[to...@apache.org]

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

tomoko 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 e9789afb39b LUCENE-10513: Run `gradlew tidy` first (#808)
e9789afb39b is described below

commit e9789afb39b9003248650afaf19d4ba9672f2994
Author: Rich Bowen <rb...@rcbowen.com>
AuthorDate: Tue Apr 12 08:22:55 2022 -0400

    LUCENE-10513: Run `gradlew tidy` first (#808)
    
    Co-authored-by: Dawid Weiss <da...@carrotsearch.com>
---
 CONTRIBUTING.md   | 2 +-
 help/workflow.txt | 3 +++
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5815de7d33e..fd9eda4ff30 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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.
 
diff --git a/help/workflow.txt b/help/workflow.txt
index f5cf713c7e5..ffb45488ddb 100644
--- a/help/workflow.txt
+++ b/help/workflow.txt
@@ -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