Skip to content

docs: refresh README and testing guidance - #6

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

Clarify test frameworks, report locations and live world integration limitations.

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: cdb12e3b-ef8e-4521-9556-02e6d662e08a
📥 Commits

Reviewing files that changed from the base of the PR and between c84b954 and 8b9b2f2.

📒 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 the test framework and where test and coverage reports are available, including which reports CI uploads.
    • Documented the in-game checks needed for live world spawning, client particles and the full server plugin stack.

Walkthrough

The README Tests section now documents JUnit 5, Surefire and JaCoCo report locations, CI report uploads, and separate in-game checks for live spawning, client particles, and the full server plugin stack.

Changes

Test documentation

Layer / File(s) Summary
Document test reports and in-game checks
README.md
The Tests section specifies JUnit 5, Surefire and JaCoCo report locations, CI uploads of both JaCoCo formats, and separate in-game checks. It removes the claim that tests run locally without a live server and replaces a JaCoCo index-file path with report directories.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 8b9b2

The documentation update is ready to merge after normal checks.

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