Skip to content

docs: refresh README and testing guidance #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanbarlow97 merged 1 commit into from
Oct 8, 2026
Merged

docs: refresh README and testing guidance #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down