Skip to content

docs: put README sections in the standard order - #27

Merged
ryanbarlow97 merged 1 commit into
mainfrom
chore/repo-norms
Oct 3, 2026
Merged

ryanbarlow97 merged 1 commit into
mainfrom
chore/repo-norms

Conversation

@ryanbarlow97

Copy link
Copy Markdown
Contributor

Summary

Part of a cross-repository audit against the TF-Minecraft repository norms (README layout per Docs MAINTAINING.md and the other plugin READMEs, POM layout per Docs POM-CONVENTIONS.md).

  • README: move sections into the standard TF-Minecraft order: introduction and features, then Documentation, Tests, and License last (Credits/narrative before Documentation).

Checks

  • README text otherwise unchanged (sections moved verbatim).

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

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: 3d96f42d-82ff-4a00-9c94-c3e599dbddad
📥 Commits

Reviewing files that changed from the base of the PR and between 62bed07 and 6ad61d3.

📒 Files selected for processing (1)
  • README.md

📝 Summary

Summary by CodeRabbit

  • Documentation
    • Added guidance on running tests, coverage requirements and CI coverage reports.
    • Clarified the integration-test boundary.

Walkthrough

The README adds a “Tests and coverage” section. It documents the Java 21 verification command, coverage enforcement and reports, test scope, and the boundary for live Minecraft integration tests. The existing licence section remains.

Changes

Test and coverage documentation

Layer / File(s) Summary
Verification and coverage guidance
README.md
The new section documents mvn clean verify with Java 21, pinned dependency preparation, JaCoCo coverage requirements, CI reports, test coverage and the live Minecraft integration-test boundary. The licence text remains unchanged.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 6ad61

This PR rearranges README guidance without changing build or CI behavior. The documented verification details match the supplied configuration, and no actionable merge risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to 6ad61

The change affects 1 system.

Changed systems: README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — README.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.md: The “Tests and coverage” section was added, documenting the verification command and Java version, coverage requirements, CI reports, test areas, test doubles and serialization approach, and separation of live Minecraft integration.
  • observed — Modified behavior in README.md: The existing licence heading and licence text remain; no change to their content is shown in this range.
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Usage-based review receipt

  • Mode: Continue automatically
  • Reviewed files: 1
  • Waived: $0.25 (charged $0.00)
  • View usage details

Note

This review exceeded your plan’s limits and used usage-based reviews—free during trial, billed after paid activation unless disabled. Manage usage-based reviews.


Comment @coderabbitai help to get the list of available commands.

@ryanbarlow97
ryanbarlow97 merged commit ca3efb9 into main Oct 3, 2026
2 checks passed
@ryanbarlow97
ryanbarlow97 deleted the chore/repo-norms branch October 3, 2026 22:54
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