Skip to content

docs: refresh README and testing guidance #16

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 #16

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 @@ -31,12 +31,16 @@ Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/

## Tests and coverage

Run `mvn clean verify` with Java 21. The build runs the unit tests and enforces
With Java 21 and the pinned plugin dependencies installed, run `mvn clean verify`.
The suite uses JUnit 5, Mockito, and MockBukkit. The build enforces
100% executable runtime **line coverage** with JaCoCo, without production-class
exclusions. Instruction and branch coverage are reported separately.

The HTML report is `target/site/jacoco/index.html`; the machine-readable report is
`target/site/jacoco/jacoco.xml`. CI uploads these reports alongside test results.
Surefire test results are in `target/surefire-reports/`. The HTML coverage report
is `target/site/jacoco/index.html`; the XML report is
`target/site/jacoco/jacoco.xml`. CI uploads the test and coverage reports.
The suite does not validate live furniture interactions, client effects, or the
complete server plugin stack.

## License

Expand Down