Skip to content

docs: refresh README and testing guidance - #16

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

Document test frameworks, report locations and limits of simulated integration checks.

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: da46c9ec-1c24-400b-98aa-d560a3148a02
📥 Commits

Reviewing files that changed from the base of the PR and between ebe582e and 25cb549.

📒 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
    • Clarified test setup requirements, including Java 21 and pinned plugin dependencies.
    • Explained how test results and coverage reports are generated and uploaded, and outlined areas the test suite does not validate.

Walkthrough

The README now lists test prerequisites, frameworks, report locations and test-suite limits. The 100% executable runtime line-coverage requirement and separate instruction and branch coverage reporting remain unchanged.

Changes

Test documentation

Layer / File(s) Summary
Test prerequisites and reporting
README.md
The README specifies Java 21 and pinned plugin dependencies, names JUnit 5, Mockito and MockBukkit, and documents Surefire and JaCoCo report locations and CI uploads. It also states that the suite does not validate live furniture interactions, client effects or the complete server plugin stack.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 25cb5

This change updates the README's test instructions and has no runtime effect. The documented Java 21 requirement matches the build configuration, so it is ready to merge.

  • 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 d6fefaa into main Oct 8, 2026
2 checks passed
@ryanbarlow97
ryanbarlow97 deleted the docs/readme-audit-20261008 branch October 8, 2026 20:18
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