Skip to content

docs: refresh README and testing guidance - #65

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 metrics details into Docs and complete testing instructions and report locations.

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: 8ad28441-8573-4a53-a3c3-bfeb5ed0e404
📥 Commits

Reviewing files that changed from the base of the PR and between 9bad61d and ad561c6.

📒 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
    • Expanded the Tests section with covered test areas, separate instruction and branch coverage reporting, and report locations.
    • Added details on when the Build workflow runs verification and uploads reports.
    • Removed descriptions of locomotive coverage and bundled bStats.

Walkthrough

The README Tests section now describes covered test areas, report locations, separate instruction and branch coverage, and Build workflow triggers and uploads. It removes the previous locomotive and bStats coverage description.

Changes

Test documentation

Layer / File(s) Summary
Tests section and report details
README.md
The Tests section lists covered areas, gives the Surefire and JaCoCo report locations, and states that instruction and branch coverage are reported separately. It describes the Build workflow’s verification triggers and report uploads. The previous locomotive and bStats coverage details are removed.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: carolinebondhus

Merge Risk: ⚪ Minimal · up to ad561

The README updates are documentation-only, and the JaCoCo coverage statement matches the project configuration. No actionable merge blocker 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 a7b4b22 into main Oct 8, 2026
2 checks passed
@ryanbarlow97
ryanbarlow97 deleted the docs/readme-audit-20261008 branch October 8, 2026 20:22
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