agentreadme

Report · marked 27 Aug 2026

ColorlibHQ/AdminLTE

An agent can work here, but it will waste turns finding its footing.

Astro · 45,555 stars · 570 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
Environment config
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.

The full marking

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

Instructions 3/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 3/3
README has a clear getting-started section.
Setup 14/20 B+

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

Deterministic install 6/6
package-lock.json pins the dependency tree.
Found package-lock.json
Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (start, dev, build, css, css-compile, css-rtl…)
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 2/2
The language runtime version is pinned.
package.json engines.node >=20
Reproducible environment 0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
Verification loop 23/25 A

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

Tests exist 6/8
11 test files against 163 source files.
e.g. tests/a11y.mjs, tests/unit/accessibility.test.ts, tests/unit/base-component.test.ts
Test command is discoverable 7/7
An agent can find and run `npm run test`.
Continuous integration 4/4
6 GitHub Actions workflows define what "passing" means.
Lint and format rules 3/3
eslint.config.js encodes the house style.
Static type checking 3/3
Strict type checking is on, which catches a whole class of agent mistakes before they run.
Context economy 19/20 A+

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 26 patterns.
File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
Repository weight 4/5
About 146.6MB checked out, which is comfortable.

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 ColorlibHQ/AdminLTE
# AGENTS.md

AdminLTE - Free admin dashboard template based on Bootstrap 5

## Setup

```
npm ci
```

## Commands

```
npm run dev           # run locally
npm run start         # run the app
npm run build         # produce a build
npm run test          # run the test suite, must pass before any commit
npm run lint          # lint
npm run css
npm run css-compile
npm run css-rtl
```

## Layout

- `src/`     134 source files
- `dist/`    14 source files
- `tests/`   11 source files
- `scripts/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `tests/a11y.mjs`.
- TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it.
- CI defines what passing means. See `.github/workflows/a11y.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.

---

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/ColorlibHQ/AdminLTE.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 66 out of 100

[![agent ready](https://agentreadme.com/badge/ColorlibHQ/AdminLTE.svg)](https://agentreadme.com/ColorlibHQ/AdminLTE)

Other Astro repositories, marked

tabler/tabler 65 B

All Astro 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