Skip to content

docs: refresh README and testing guidance - #25

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 JUnit 4 and the absence of a coverage gate; move optional plugin API contract instructions into Docs.

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: 348c1fa7-4227-4137-9ddb-001a0c471d9a
📥 Commits

Reviewing files that changed from the base of the PR and between 5ae0cfb and b3142e3.

📒 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 testing guidance to describe JUnit, Mockito and MockBukkit coverage, Surefire results, JaCoCo reports and uploaded build artifacts.
    • Clarified that the standard test suite does not require private plugin JARs or a running Paper server.
    • Added a reference to guidance for optional ItemsAdder and MMOItems adapter contract tests.

Walkthrough

The README Tests section now summarises the ordinary test suite, report locations, workflow uploads, and optional adapter contract tests.

Changes

Testing documentation

Layer / File(s) Summary
Test suite guidance
README.md
The Tests section describes JUnit 4, Mockito and MockBukkit coverage, Surefire results, JaCoCo reports, workflow uploads, and the absence of a minimum coverage gate. It links to the testing guide for optional ItemsAdder and MMOItems adapter contract tests.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to b3142

The README directs optional-test users to a guide with the complete JAR prerequisites, so the documented setup is complete and no merge-blocking concern remains.

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