Skip to content

docs: move planting configuration to Docs and add a Tests section - #63

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

  • Moves the two open-sky planting paragraphs (the rule and the planting keys in crops.yml) out of "A complete food journey" into the Docs crops guide. The narrative paragraph stays, opening with a short player-facing sentence that crops need open sky or a glass greenhouse roof.
  • Adds a short ## Tests section between Documentation and License: the mvn clean verify command, JUnit 5 with MockBukkit/Mockito, Surefire report upload, no coverage gate (the POM has no JaCoCo), and the live-server limit.

Paired Docs PR: TF-Minecraft/Docs#90. Merge it first or together with this one.

Checks

  • README section order now matches the workspace norm: intro, Features, narrative, Documentation, Tests, License.
  • Moved text verified against CropPlantingRule and crops.yml.

🤖 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: 72c6b59d-e127-44a7-9f84-9af296ef0f37
📥 Commits

Reviewing files that changed from the base of the PR and between 01298b4 and 2e7de17.

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

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


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the food-journey description to cover crops grown outdoors or in greenhouses, and how harvests become food.
    • Removed guidance on crop-planting rules and crops.yml, including roof and open-sky behaviour, crop exemptions, reloads, and the effect of adding a roof after planting.
    • Added a Tests section documenting the Java 21 Maven verification command, JUnit 5 suite and workflow reporting. It also notes that there is no coverage gate and live-server checks are not included.

Walkthrough

The README replaces detailed crop planting rules with a brief food-journey description. It adds Java 21 and Maven test guidance, including notes on test reports and coverage.

Changes

README documentation

Layer / File(s) Summary
Crop and test guidance
README.md
The README describes outdoor and greenhouse crop growing, retains the documentation links, and adds Java 21 setup, Maven verification, JUnit 5, workflow report, and coverage details.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: xxfran10xx

Merge Risk: ⚪ Minimal · up to 2e7de

The PR updates crop and test guidance without changing runtime behavior. Its Java and Maven instructions match the checked-in build setup, and no actionable merge risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to 2e7de

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 food-journey text now describes outdoor and greenhouse crop growing and replaces the removed planting rules, configuration options, defaults, and existing-crop behaviour.
  • observed — Modified behavior in README.md: The Documentation heading and links remain, but are retained as part of the replacement for the removed crop-planting guidance.
  • observed — Modified behavior in README.md: A Tests section adds Java 21 setup guidance and the Maven verification command, describes the JUnit 5 coverage and workflow Surefire reports, and states that there is no coverage gate or substitute for live Paper-server checks.
  • 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 fd12685 into main Oct 3, 2026
2 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