Skip to content

docs: refresh README and testing guidance - #29

Merged
ryanbarlow97 merged 1 commit into
mainfrom
docs/readme-audit-20261008
Oct 8, 2026
Merged

ryanbarlow97 merged 1 commit into
mainfrom
docs/readme-audit-20261008

Conversation

@ryanbarlow97

Copy link
Copy Markdown
Contributor

Move dependency setup into Docs and describe the test suite, reports and absence of a coverage threshold.

Follows the README layout and documentation ownership rules in TF-Minecraft/Docs. Related guide updates: TF-Minecraft/Docs#110.

Validation: git diff --check; README links, source paths and anchors checked against the task worktrees. Feature and test claims checked against current source and build configuration. Plugin/runtime suites were not rerun for these documentation edits.

@coderabbitai

coderabbitai Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 913b04b2-9c2e-48bd-884f-b56fb0b8f9ad
📥 Commits

Reviewing files that changed from the base of the PR and between dba496f and 531b690.

📒 Files selected for processing (1)
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the test instructions with Java 21 and build-dependency prerequisites, plus the mvn clean verify command.
    • Added details on test coverage, report availability, and the test environment.

Walkthrough

The README replaces manual test setup instructions with Java 21 and prepared build dependencies, followed by mvn clean verify. It also documents test coverage, report handling, and the test environment.

Changes

Test documentation

Layer / File(s) Summary
Document the test workflow
README.md
The Tests section documents the prerequisites and mvn clean verify command. It describes JUnit 5 and Mockito coverage, Surefire report handling, the absence of a configured coverage report or threshold, and testing without a live server or real economy and faction plugins.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 531b6

This is a documentation-only update to the test instructions. It does not change runtime behavior and has no merge-blocking risk.

  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ryanbarlow97
ryanbarlow97 merged commit 015f1b9 into main Oct 8, 2026
2 checks passed
@ryanbarlow97
ryanbarlow97 deleted the docs/readme-audit-20261008 branch October 8, 2026 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant