Skip to content
This repository was archived by the owner on Oct 14, 2026. It is now read-only.

docs: refresh README and testing guidance #25

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

docs: refresh README and testing guidance #25

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
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,16 @@ Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/

## Tests and coverage

Run `mvn clean verify` with Java 21 after installing the pinned dependencies. JaCoCo checks 100% executable runtime line coverage with no production-code exclusions. Instruction and branch coverage are reported separately in `target/site/jacoco/`; CI uploads the report for every build and release.
Run `mvn clean verify` with Java 21 after installing the pinned dependencies
using the [build guide](https://github.com/TF-Minecraft/Docs/blob/main/projects/PermCleaner/README.md#build-and-dependencies).
JUnit 5 and Mockito cover permission filtering, season stamps, commands,
listeners, lifecycle, and asynchronous cleanup. Surefire test results are in
`target/surefire-reports/`.

JaCoCo enforces 100% executable runtime line coverage with no production-code
exclusions. Instruction and branch coverage are reported separately in
`target/site/jacoco/`; build and release CI upload generated coverage reports.
Mocks do not verify a live LuckPerms server or its shared storage.

## License

Expand Down