valkyrjaio / valkyrja-starter-app-java / 32207985403

100%

push

github

[Fixture] docs: Reduce the runtime harness doc block to the one allowed line (#139)

# Description

Golden rule 15 gives a test fixture one line on the declaration, which
says what the fixture is for. `RuntimeServerFixture` carried a paragraph
instead.

It kept its opening sentence. The detail it dropped listed the steps the
harness performs — reserving a port, waiting for the server to accept,
making a request, tearing down — which its own methods show.

This is a partial pass. The entry points and the routing demonstration
classes under `app/src` stay for now, because each documents a bootstrap
model or the permutations it covers, which the declaration cannot show.
Rule 15 moves that material to the component documentation rather than
deleting it, so those blocks need the documentation written first.

Test classes are out of scope. Rule 15 names a test fixture as the
exception and says nothing about a test class.

The diff contains no executable change and Spotless passes. The JUnit
build was not run: it fails on this branch and on an untouched checkout
alike, because `app.cli.data` and `app.grpc.data` are generated by
Sindri before compilation and a fresh worktree has no generated sources.

## Types of changes

- [ ] Improvement _(non-breaking change which improves code)_
- [ ] Bug fix _(non-breaking change which fixes an issue)_
- [ ] New feature _(non-breaking change which adds functionality)_
- [ ] Deprecation _(breaking change which removes functionality)_
- [ ] Breaking change _(fix or feature that would cause existing
functionality to change)_
- [x] Documentation improvement

## Changes

- **`RuntimeServerFixture.java`** — reduced the declaration block to the
one line rule 15 allows

22 of 22 branches covered (100.0%)

Branch coverage included in aggregate %.

295 of 295 relevant lines covered (100.0%)

4.83 hits per line