From f44c7a12701829a7df8600eca74ed8ad3b3f73bd 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 | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3e3902e..8529fba 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,13 @@ Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/ ## Tests and coverage -Run `mvn clean verify` with Java 21 and the pinned plugin dependencies installed. -The build runs the tests and enforces **100% executable-line coverage** across +Run `mvn clean verify` with Java 21. JUnit 5, Mockito and MockBukkit exercise +border zones, warnings, damage, permissions, configuration, commands and plugin +lifecycle. No private plugin JARs are needed. Surefire writes test results to +`target/surefire-reports/`; the Build workflow uploads them. These tests do not +start a live Paper server or verify client title rendering. + +The build enforces **100% executable-line coverage** across all production Java classes, with no coverage exclusions. JaCoCo's HTML and XML reports are written to `target/site/jacoco/` and uploaded by the Build workflow. Branch and instruction coverage are reported separately; the enforced threshold