Skip to content

docs: refresh README and testing guidance #7

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

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
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,14 @@ 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 prepared by
`.github/scripts/prepare-release.sh`. JUnit and MockBukkit test the plugin logic;
Run `mvn clean verify` with Java 21 after preparing shared plugin dependencies
with the pinned installer and private inputs with `.github/scripts/prepare-release.sh`
(see the project documentation). JUnit and MockBukkit test the plugin logic;
Mockito isolates external plugin APIs and selected Bukkit entity boundaries.
JaCoCo requires 100% production instruction, branch, and line coverage with no
coverage exclusions. HTML and XML reports are written to `target/site/jacoco/`
and uploaded by CI. These tests do not replace live Paper/MythicMobs integration checks.
and uploaded by the Build workflow alongside `target/surefire-reports/` test results.
These tests do not replace live Paper/MythicMobs integration checks.

## License

Expand Down
Loading