Skip to content

docs: put README sections in the standard order and add tests - #21

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).
  • README: add the Tests section that other plugin repos with test suites carry, based on the build workflow and pom.xml.

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: ad812c83-ddfe-427f-b8d7-e2fbf8f2943f
📥 Commits

Reviewing files that changed from the base of the PR and between a9d8188 and 9d9629f.

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

Limit details: You’ve used all 10 included reviews currently available.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Added a README section describing how to run the test suite with Java 21 and mvn clean verify, which test frameworks are used, and where to find the JaCoCo coverage report.
    • Documented the 100% instruction and branch coverage requirement.
    • Moved the License section to follow the new Tests and coverage section.

Walkthrough

The README adds testing and coverage requirements, then places the License section after them.

Changes

README documentation

Layer / File(s) Summary
Testing and licence section
README.md
Adds the Java 21 requirement, mvn clean verify command, test frameworks, JaCoCo report location, and 100% instruction and branch coverage requirement. Moves the License section after this content.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: justinasla

Merge Risk: ⚪ Minimal · up to 9d962

The README’s testing instructions and relocated License section preserve the documented project guidance; no actionable merge risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to 9d962

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 License section and its Artistic License, copyright, and third-party licence statements were removed from this position.
  • observed — Modified behavior in README.md: A Tests and coverage section was added with the Java 21 requirement, verification command, named test frameworks, JaCoCo report location, and required 100% instruction and branch coverage. The License section and its licence and copyright statements now follow it.
  • 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 5077964 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