Skip to content

docs: refresh README and testing guidance - #22

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 suite scope, both report locations, coverage gates and item-plugin/audio 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: 8b3aeeca-0e4f-47be-a198-2b957755c0f8
📥 Commits

Reviewing files that changed from the base of the PR and between 5077964 and 4da3b6d.

📒 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 coverage, reporting locations and the 100% coverage requirement.
    • Distinguished tests using item-plugin stand-ins from live integrations and resource-pack audio, which require Minecraft server and client testing.

Walkthrough

The README updates test instructions with JUnit 5, MockBukkit coverage areas, report locations, and coverage requirements. It also specifies which tests require a Minecraft server and client.

Changes

Test documentation

Layer / File(s) Summary
Test and coverage guidance
README.md
The README names JUnit 5 and MockBukkit test areas, documents Surefire and JaCoCo reports and coverage requirements, and states that live integrations and resource-pack audio need server and client testing.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: justinasla

Merge Risk: ⚪ Minimal · up to 4da3b

The README accurately describes the test and live-testing boundaries; no PR-specific issue remains that should block merging.

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