agentreadme

Report · marked 25 Aug 2026

eugenp/tutorials

An agent is close to flying blind in this repository.

Java · 37,327 stars · 26,292 files · branch master

Fix these first

01
Agent instruction file
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
03
Test command is discoverable
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.

The full marking

Every deduction below names the file or setting it came from.

Instructions 2/27 F

Whether the repo tells an agent how to behave before it starts guessing.

Agent instruction file 0/12
None found. Every agent that opens this repo starts from zero.
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules
Instruction quality 0/12
Nothing to judge, since there are no instructions.
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
README as an entry point 2/3
README exists but never explains how to get the thing running.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 0/18 F

Whether an agent can install the project and get it running without a human.

Deterministic install 0/6
No lockfile. An agent installing dependencies may not get what CI got.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
Discoverable commands 0/6
No declared commands. An agent has to infer how to build and run this from the file tree.
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
Environment config 0/4
Nothing documents the environment this needs. An agent will get a runtime error it can't diagnose.
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
Pinned runtime version 0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 12/22 B-

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

Tests exist 8/8
7221 test files against 19829 source files.
e.g. akka-modules/akka-actors/src/test/java/com/baeldung/akkaactors/AkkaActorsUnitTest.java, akka-modules/akka-http/src/test/java/com/baeldung/akkahttp/UserServerUnitTest.java, akka-modules/akka-streams/src/test/java/com/baeldung/akkastreams/DataImporterUnitTest.java
Test command is discoverable 0/7
There's no obvious way to run the tests. Even if tests exist, an agent won't reliably find the entry point.
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.
Continuous integration 4/4
jenkinsfile defines what "passing" means.
Lint and format rules 0/3
No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
Static type checking n/a
Not applicable — the Java compiler type checks every build.
Context economy 13/20 B

Whether the repo fits in a context window, or fights it.

No committed build output 6/6
No generated directories committed.
.gitignore hygiene 3/3
.gitignore covers 117 patterns.
File sizes fit in context 0/6
7 source files are over 100KB.
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
spring-cloud-modules/spring-cloud-bootstrap/gateway/src/main/resources/static/home/server/server.mjs — 1080KB
spring-boot-modules/spring-boot-nashorn/src/main/resources/static/js/react.js — 626KB
spring-cloud-modules/spring-cloud-bootstrap/gateway/src/main/resources/static/home/server/chunk-TVQO2A6G.mjs — 546KB
Repository weight 4/5
About 132.5MB checked out, which is comfortable.
File tree exceeded GitHub's limit, so 51,361 entries were sampled

Here is your AGENTS.md

Drafted from what is actually in this repository: the install command from your lockfile, the commands you already declare, your real directory layout. Anything marked TODO needs a person. Save it at the root as AGENTS.md.

AGENTS.md — drafted for eugenp/tutorials
# AGENTS.md

Getting Started with Spring Boot 3: 

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `core-java-modules/`    4853 source files
- `persistence-modules/`  3388 source files
- `spring-boot-modules/`  2514 source files
- `jhipster-8-modules/`   962 source files
- `patterns-modules/`     745 source files
- `spring-cloud-modules/` 567 source files

## Conventions

- Tests live alongside the code they cover, following `akka-modules/akka-actors/src/test/java/com/baeldung/akkaactors/AkkaActorsUnitTest.java`.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `spring-cloud-modules/spring-cloud-bootstrap/gateway/src/main/resources/static/home/server/server.mjs` is 1080KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.

Open the raw markdown  or  curl -o AGENTS.md agentreadme.com/draft/eugenp/tutorials.md

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

agent ready 35 out of 100

[![agent ready](https://agentreadme.com/badge/eugenp/tutorials.svg)](https://agentreadme.com/eugenp/tutorials)

Other Java repositories, marked

krahets/hello-algo 37 D iluwatar/java-design-patterns 57 B- Stirling-Tools/Stirling-PDF 69 B macrozheng/mall 28 F spring-projects/spring-boot 41 C doocs/advanced-java 54 C+

All Java repositories

Think this mark is wrong?

Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.

Open an issue, already filled in

This repository is large enough that GitHub truncated the file listing, so the file-level checks ran on a sample.