36 lines
1.6 KiB
Markdown
36 lines
1.6 KiB
Markdown
# werkprobe — Agent Instructions
|
|
|
|
This file holds the shared, tool-agnostic instructions for all AI coding agents.
|
|
Claude Code imports it from `CLAUDE.md` via `@AGENTS.md`.
|
|
|
|
## Project
|
|
|
|
werkprobe is a work sample for [werkdock](https://git.javagil.de/mi/werkdock):
|
|
real Testcontainers programs, run against werkdock instead of docker.
|
|
Nothing in it may know that it talks to werkdock; the only adaptation is `DOCKER_HOST` and `TESTCONTAINERS_RYUK_DISABLED`.
|
|
The [README](README.md) describes each test and how to run it.
|
|
|
|
werkprobe is also the demo of [werkcrappit](https://git.javagil.de/mi/werkcrappit)'s charts:
|
|
the package `werkprobe.shop` is written to show each colour of its code city, structure page and matrix once.
|
|
Its flaws are on purpose: the class cycle, the two package cycles, the classes with LCOM4 2 and 3,
|
|
and the weak tests of `Discounts` and `Catalog`.
|
|
Do not fix them; a change of the shop keeps every colour, as the README lists them.
|
|
|
|
## Build and Test Commands
|
|
|
|
```bash
|
|
./gradlew build # compile + all container tests; needs a werkdock or docker socket in DOCKER_HOST
|
|
./gradlew bootRun # the Spring Boot application on its own
|
|
./gradlew pitest mutationCrapCodeCharta # the shop demo: build/reports/codecharta/index.html, structure.html, matrix.html
|
|
```
|
|
|
|
The CI on werkator.javagil.de runs the container tests against werkdock.
|
|
|
|
## Workflow
|
|
|
|
Follow [docs/agentic-workflow.md](docs/agentic-workflow.md), the workflow of all werk repositories:
|
|
roles, steps of a PR, review rounds, PR documents and the writing style.
|
|
In addition, for werkprobe:
|
|
|
|
- werkprobe is a probe that is never released, so it has no version, no release notes and no Werkbaum plan.
|