Skip to content

docs: refresh README and testing guidance - #11

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

Keep feature prose concise and document test tools, report locations and live encounter 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: 3680ae91-c068-40ef-b00e-1155702e8b03
📥 Commits

Reviewing files that changed from the base of the PR and between 9514957 and b13de18.

📒 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 that committed players continue taking damage until they opt out.
    • Expanded testing and coverage information, including test reports and behaviours not covered by the test suite.

Walkthrough

The README now describes opting out of a fight and documents the test frameworks, Surefire report location, and limits of simulated test coverage.

Changes

README updates

Layer / File(s) Summary
Player and test documentation
README.md
The committed-player description now says players can opt out of the fight. The test section names JUnit, MockBukkit, and Mockito, gives the Surefire report path, and notes that the simulated suite does not validate live Paper spawning, MythicMobs encounters, or map-service behaviour.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: drefvelin

Merge Risk: ⚪ Minimal · up to b13de

The README’s test guidance matches the project configuration, and players can find the opt-out command in the registered command usage. No actionable merge risk 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 b6c5905 into main Oct 8, 2026
2 checks passed
@ryanbarlow97
ryanbarlow97 deleted the docs/readme-audit-20261008 branch October 8, 2026 20:28
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