Skip to content

docs: drop RELEASE.md and put License last - #35

Merged
ryanbarlow97 merged 1 commit into
mainfrom
docs/readme-norms
Oct 3, 2026
Merged

ryanbarlow97 merged 1 commit into
mainfrom
docs/readme-norms

Conversation

@ryanbarlow97

Copy link
Copy Markdown
Contributor

Summary

  • Delete RELEASE.md, which duplicated Docs PIPELINES.md; TLibs-specific details move to the Docs TLibs index. DEPENDENCIES.md stays (it never linked to RELEASE.md).
  • Move the README License section after Tests and coverage.
  • Order pom.xml properties: maven.compiler.release, project.build.sourceEncoding, maven.compiler.proc, then the rest alphabetically.

Paired Docs PR: TF-Minecraft/Docs#95 (merge it first or together).

Checks

  • mvn -o org.apache.maven.plugins:maven-help-plugin:3.5.2:effective-pom output is byte-identical before and after the POM change.

🤖 Generated with Claude Code

RELEASE.md duplicated the shared pipeline guide; its TLibs-specific
details now live in the Docs TLibs project index. Move the License
section to the end of the README and order the POM properties as
release, encoding and proc first, then alphabetically. The effective
POM is unchanged.

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: 02f7956e-7300-4a16-b346-c04f17d2573f
📥 Commits

Reviewing files that changed from the base of the PR and between bcaa738 and aa054ab.

📒 Files selected for processing (3)
  • README.md
  • RELEASE.md
  • pom.xml
💤 Files with no reviewable changes (1)
  • RELEASE.md

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


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Moved the License section in the README to after Tests and coverage; its content is unchanged.
    • Removed the release guidance document, including information about Java 21 builds, release versioning and workflow artifacts.
  • Chores
    • Reordered Maven build properties; their values are unchanged.

Walkthrough

The README License section was moved after Tests and coverage. RELEASE.md was deleted. The Maven argLine property was reordered without changing its value.

Changes

Documentation updates

Layer / File(s) Summary
README and release documentation
README.md, RELEASE.md
The License section now follows Tests and coverage. RELEASE.md, including its release guidance, was deleted.

Maven property ordering

Layer / File(s) Summary
Maven property ordering
pom.xml
The argLine property now follows the compiler properties. Property values remain unchanged.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: carolinebondhus

Merge Risk: ⚪ Minimal · up to aa054

No actionable merge-blocking risk is established from the available evidence.

Architecture Summary

Architecture risk: 🔵 Low · up to aa054

The change affects 3 systems.

Changed systems: pom.xml, README.md, RELEASE.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.
  • observed — RELEASE.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 its former position before Tests and coverage.
  • observed — Modified behavior in README.md: The License section was added after Tests and coverage with its existing copyright and licensing text.
  • observed — Modified behavior in RELEASE.md: Deleted RELEASE.md, including its build prerequisites, v* tag versioning and draft-release workflow description, artifact review instruction, and links to dependency and shared release guidance.
  • observed — Modified behavior in pom.xml: Reordered the argLine property to appear after the compiler properties; all four property values remain unchanged.
  • 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 5561340 into main Oct 3, 2026
4 checks passed
@ryanbarlow97
ryanbarlow97 deleted the docs/readme-norms branch October 3, 2026 22:55
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