Skip to content

docs: refresh README and testing guidance - #91

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

Correct automatic daily rewards and summarize weekly reward locking; add exact test-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: 10ecf17d-ab3a-4e81-82c7-203c19e90440
📥 Commits

Reviewing files that changed from the base of the PR and between c16a41b and d1fd53d.

📒 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 weekly reward selections stay fixed unless staff update them, and that eligible players receive a separate reward after revealing all daily tasks.
    • Updated testing documentation with build preparation, test tools, CI checks and report locations.

Walkthrough

The README now describes weekly reward selections and automatic rewards for eligible players. It also updates test dependencies, tools, CI triggers, and report details.

Changes

README documentation

Layer / File(s) Summary
Feature and test guidance
README.md
The feature descriptions cover week-locked selections and automatic rewards for eligible players. The test instructions name Mockito, specify CI triggers on pushes and pull requests to main, and identify the Surefire and JaCoCo report locations and uploaded directories.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: xxfran10xx

Merge Risk: ⚪ Minimal · up to d1fd5

The updated feature and testing guidance has no established merge-blocking mismatch.

  • 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 17c28f9 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