From 4da3b6dfb4b7ea57efeab7a086c6c0aa9fd6bfd7 Mon Sep 17 00:00:00 2001 From: Ryan Barlow <7389646+ryanbarlow97@users.noreply.github.com> Date: Thu, 8 Oct 2026 19:03:45 +0000 Subject: [PATCH] docs: refresh README and testing guidance --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bdfd0fa..9ae2fbc 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,13 @@ Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/ ## Tests and coverage -With Java 21 installed, run `mvn clean verify`. Tests use JUnit, Mockito, and -MockBukkit and run without a live Minecraft server. JaCoCo writes its report to -`target/site/jacoco/`, and `verify` requires 100% instruction and branch coverage. +With Java 21 installed, run `mvn clean verify`. Tests use JUnit 5, Mockito, and +MockBukkit for playback, commands, item resolution, configuration, and lifecycle +behaviour. Surefire writes test results to `target/surefire-reports/`; JaCoCo +writes HTML and XML reports to `target/site/jacoco/`. Verification requires 100% +instruction and branch coverage, with no production-code exclusions. Tests use +stand-ins for item plugins; live integrations and resource-pack audio still +need Minecraft server and client testing. ## License