[jira] [Created] (LUCENE-10513) Make it more obvious how to fix Spotless issues for new users

["Rich Bowen (Jira)" <ji...@apache.org>]

Rich Bowen created LUCENE-10513:
-----------------------------------

             Summary: Make it more obvious how to fix Spotless issues for new users
                 Key: LUCENE-10513
                 URL: https://issues.apache.org/jira/browse/LUCENE-10513
             Project: Lucene - Core
          Issue Type: Task
            Reporter: Rich Bowen


I just made my first PR to Lucene (yay me!) and in the process stumbled on various things that were non-obvious.

I request, for The Next Person, that the error messaging in `gradlew` make it more obvious that one should run `./gradlew tidy` the first time around, so as to avoid the low-hanging formatting problems that cause everything else to fail.

During the course of my fumbling around, I was encouraged to run:

./gradlew :lucene:suggest:spotlessJavaCheck

./gradlew :lucene:suggest:spotlessApply

./gradlew :lucene:test-framework:spotlessApply

and

./gradlew check -Ptests.nightly=true

various times, by the error messages in `./gradlew check`, and while I got there eventually (again, yay me!) perhaps encouraging folks to run `./gradlew tidy` first may have saved some frustration.

That said, I cannot overstate how impressed I am with the thoroughness of the testing/verification tools, and wish more projects had this kind of tooling. Thank you.

 



--
This message was sent by Atlassian Jira
(v8.20.1#820001)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org