janhoy commented on code in PR #5323: URL: https://github.com/apache/solr/pull/5323#discussion_r4552828222
########## dev-docs/writing-tests.adoc: ########## @@ -0,0 +1,173 @@ += Writing Tests for Solr +:toc: left +:toclevels: 2 + +Which kind of test to write, and the lifecycle conventions they all share. Building and running the suite is covered in xref:solr-source-code.adoc[Working With Solr Source Code]; `./gradlew helpTests` covers running them. + +The rule: *write the cheapest kind of test that can actually catch the bug.* + +== Test types + +[cols="1,2,1,1", options="header"] +|=== +| Base class | Covers | Cost | Status + +| `SolrTestCase` Review Comment: @dsmiley I know this is your pet as well. I may be stepping on your feet on this one -- I looked but could not find an existing dev-docs guide on writing tests. You may have one in Wiki or in another PR, don't know. But I'm happy to hand this off to you, to lift it out of this PR, probably discard lots of wrong advice and land it in its own PR... I did not intend to own this file, but it felt natural to document this aspect, not only for LLMs, thus also the corresponding removal of related advice from AGENTS.md. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
