Skip to content

docs: refresh README and testing guidance - #38

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, prerequisites, report paths and live 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: 1fa20297-976f-4de6-8815-cff2fbbe297a
📥 Commits

Reviewing files that changed from the base of the PR and between ceeb5b4 and dfa8448.

📒 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 testing prerequisites, the roles of the test frameworks, and the 100% production line coverage requirement.
    • Specified where test and coverage reports are found, and distinguished automated tests from live integration checks.

Walkthrough

The README now documents test prerequisites, frameworks, coverage enforcement, report locations, and the distinction between automated tests and live integration checks.

Changes

Testing documentation

Layer / File(s) Summary
Test and report guidance
README.md
The instructions specify Java 21 and prepared build dependencies, name JUnit 5, Mockito, and MockBukkit, and describe JaCoCo’s 100% production line-coverage rule. They identify Surefire and JaCoCo report locations, state that the Build workflow uploads both report directories, and list live integration checks not covered by automated tests.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to dfa84

The testing guidance is ready to merge after normal documentation 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 71dc92f 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