Skip to content

docs: refresh README and testing guidance - #33

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

Move recovery, command and dependency details into Docs; document current tests and coverage reports.

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: a503de1c-b7be-4aff-a07f-eab72e228da7
📥 Commits

Reviewing files that changed from the base of the PR and between 0c509ef and 817af97.

📒 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 recipient opt-out guidance: characters can be hidden through RPCharacters, and mail that has already been sent still arrives.
    • Clarified testing prerequisites and instructions, including Java 21 and the mvn clean verify command.
    • Added details on the test scope, JaCoCo HTML and XML report locations, and report directories uploaded by the Build workflow.

Walkthrough

The README revises the recipient mail opt-out description and updates the test prerequisites, verification command, coverage summary, and JaCoCo report locations.

Changes

README updates

Layer / File(s) Summary
Mail and test guidance
README.md
The opt-out description no longer lists RPCharacters commands or says mail is returned before sender confirmation. The Tests section now specifies Java 21, mvn clean verify, JUnit 5 and Mockito coverage, JaCoCo report locations, and report directories uploaded by the Build workflow.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 817af

The updated test guidance preserves the build prerequisites and matches the reported artifact locations. The documentation change 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 69584b0 into main Oct 8, 2026
2 checks passed
@ryanbarlow97
ryanbarlow97 deleted the docs/readme-audit-20261008 branch October 8, 2026 20:24
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