Skip to content

chore: align README and pom.xml with TF-Minecraft conventions - #30

Merged
ryanbarlow97 merged 2 commits into
mainfrom
chore/repo-norms
Oct 3, 2026
Merged

ryanbarlow97 merged 2 commits 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).
  • pom.xml: order properties per Docs POM-CONVENTIONS.md: maven.compiler.release, project.build.sourceEncoding, maven.compiler.proc, then the rest alphabetically (see docs: place maven.compiler.proc after the encoding property Docs#87).

Checks

  • README text otherwise unchanged (sections moved verbatim).
  • Effective POM (maven-help-plugin:3.5.2:effective-pom, offline) compared before and after: identical apart from property order.

🤖 Generated with Claude Code

ryanbarlow97 and others added 2 commits October 3, 2026 22:36
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Put maven.compiler.release and project.build.sourceEncoding first, then
maven.compiler.proc, then the remaining properties alphabetically. The
effective POM is unchanged apart from property order.

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: b66f09e6-6f3f-42d2-982b-c59f7e427844
📥 Commits

Reviewing files that changed from the base of the PR and between 497d622 and 15314bf.

📒 Files selected for processing (2)
  • README.md
  • pom.xml

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


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Added a Tests and coverage section to the README, including the Java 21 verification command, coverage requirements and separately reported instruction and branch coverage.
    • Documented where to find the HTML and XML coverage reports and how reports are uploaded in CI.
    • Moved the existing License section below the new testing information; its text is unchanged.

Walkthrough

The README adds instructions for running tests and coverage checks, and documents JaCoCo reports and CI uploads. The Maven property order changes, but the property values remain unchanged.

Changes

Test and coverage documentation

Layer / File(s) Summary
Document verification and coverage
README.md
The README documents the Java 21 mvn clean verify command, runtime line-coverage enforcement, instruction and branch coverage reporting, and JaCoCo report paths and CI uploads. The unchanged License section follows the new section.

Maven property ordering

Layer / File(s) Summary
Reorder Maven properties
pom.xml
The compiler properties move before the empty Surefire argLine property. No property values change.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to 15314

The changes introduce no verified build or runtime regression and are safe to merge with normal checks.

Architecture Summary

Architecture risk: 🔵 Low · up to 15314

The change affects 2 systems.

Changed systems: pom.xml, README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — pom.xml (service) was modified; 1 changed file maps to changed impact.
  • 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 was removed from this position; its unchanged text appears later in the README.
  • observed — Modified behavior in README.md: The Tests and coverage section was added, documenting the verification command, coverage requirements and reports. The existing License section follows it unchanged.
  • observed — Modified behavior in pom.xml: The compiler release, source encoding and annotation-processing properties move ahead of the unchanged empty argLine property; no property values change.
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Usage-based review receipt

  • Mode: Continue automatically
  • Reviewed files: 2
  • Waived: $0.50 (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 4bacf2c 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