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

["Dawid Weiss (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/LUCENE-10513?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17520641#comment-17520641 ] 

Dawid Weiss commented on LUCENE-10513:
--------------------------------------

You should make yourself familiar with various help files under help/, here is one of them explicitly talking about formatting:

[https://github.com/apache/lucene/blob/main/help/formatting.txt]

I don't think more can be done about it, to be honest.

> 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
>            Priority: Minor
>
> 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