Skip to content

docs: refresh README and testing guidance #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanbarlow97 merged 2 commits into from
Oct 8, 2026
Merged

docs: refresh README and testing guidance #66

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6dbfef6
docs: refresh README and testing guidance
ryanbarlow97 Oct 8, 2026
0f2dddb
docs: correct seafood portion description
ryanbarlow97 Oct 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Cooking makes food an interactive part of everyday life. Players grow and gather
- **Serving and sharing** — plate dishes, ladle soup into bowls, and carve foods into portions for the table.
- **Quality and freshness** — ingredient quality and composition influence finished dishes, while aging and food tags carry preparation history through the kitchen.
- **Farming and husbandry** — crop fertility and harvest quality sit alongside animal care, breeding, genetics, and produce collection.
- **Fish and seafood** — turn supported catches into cooking ingredients while preserving catch size.
- **Character nutrition** — meals feed a character's food reserve and influence diet quality, with variety rewarding a broader selection of ingredients.

## A complete food journey
Expand All @@ -25,18 +26,20 @@ Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/

## Tests

With Java 21 and the pinned plugin dependencies installed (see the build workflow), run:
With Java 21 and the [build dependencies](https://github.com/TF-Minecraft/Docs/blob/main/projects/Cooking/README.md#build-and-dependencies) prepared, run:

```sh
mvn -B --no-transfer-progress clean verify
```

The JUnit 5 suite covers food parsing and items, crops, husbandry, nutrition,
fishing and configuration loading, using MockBukkit and Mockito where Bukkit or
plugin APIs are involved. The Build and release workflows run the same command,
and the Build workflow uploads the Surefire reports. JaCoCo requires 100% line
coverage across all production classes, with no coverage exclusions. HTML and XML
reports are written to `target/site/jacoco/` and uploaded by the Build workflow.
plugin APIs are involved. Build and release CI run the same verification. The
Build workflow uploads Surefire results from `target/surefire-reports/`. JaCoCo
requires 100% line coverage across all production classes, with no coverage
exclusions. HTML and XML
reports are `target/site/jacoco/index.html` and `target/site/jacoco/jacoco.xml`,
and the Build workflow uploads that directory.
The tests do not replace checking kitchens, crops and livestock on a live Paper
server with the pinned integrations.

Expand Down
Loading