From b3142e398d44e557a56dc614f08baaae53ae54aa Mon Sep 17 00:00:00 2001 From: Ryan Barlow <7389646+ryanbarlow97@users.noreply.github.com> Date: Thu, 8 Oct 2026 19:00:58 +0000 Subject: [PATCH] docs: refresh README and testing guidance --- README.md | 34 +++++++++------------------------- 1 file changed, 9 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 496e46e..1818d2f 100644 --- a/README.md +++ b/README.md @@ -34,31 +34,15 @@ Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/ ## Tests -With Java 21 and Maven installed, run `mvn clean verify`. Tests exercise domain -rules, YAML persistence, and plugin workflows using JUnit, Mockito, and MockBukkit. -JaCoCo measures all production classes and writes its HTML report to -`target/site/jacoco/index.html` and machine-readable results to -`target/site/jacoco/jacoco.xml`. The build workflow uploads the coverage report. - -Tests should assert gameplay behavior, data preservation, or failure handling. -Do not add tests solely to execute a line or manufacture unreachable states to -increase coverage. MockBukkit tests do not replace testing on a real Paper server -with the optional ItemsAdder and MMOItems integrations installed. - -Adapter contract tests can also run against locally supplied plugin jars: - -```sh -mvn -Ppack-api-tests clean verify \ - -Ditemsadder.jar=/path/to/ItemsAdder.jar \ - -Dfastnbt.jar=/path/to/FastNbt-jar.jar \ - -Dmmoitems.jar=/path/to/MMOItems.jar \ - -Dmythiclib.jar=/path/to/MythicLib.jar -``` - -These tests bind the actual API classes and mock their external operations; they -do not start those plugins. The jars remain outside this repository and are used -only on the test runtime classpath. Use the FastNbt version declared by your -ItemsAdder jar. The ordinary test suite needs none of these files. +With Java 21 and Maven installed, run `mvn clean verify`. JUnit 4, Mockito and +MockBukkit test domain rules, YAML persistence and plugin workflows. Surefire +results are in `target/surefire-reports/`. JaCoCo reports all production classes +in `target/site/jacoco/index.html` and `target/site/jacoco/jacoco.xml`; no minimum +coverage gate is enforced. The Build workflow uploads both report directories. + +The ordinary suite needs no private plugin JARs and does not start a live Paper +server. See the [testing guide](https://github.com/TF-Minecraft/Docs/blob/main/projects/Archaeo/docs/testing.md) +for optional adapter contract tests with ItemsAdder and MMOItems API JARs. ## License