agentreadme

Report · marked 10 Oct 2026

penpot/penpot

Solid foundations, held back in a few specific places.

Clojure · 60,872 stars · 6,540 files · branch develop

Fix these first

01
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.
02
File sizes fit in context
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.
03
Instruction quality
Worth fixing: it never states a build, test, or run command.

The full marking

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

Instructions 23/27 A

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

✓Agent instruction file 12/12
AGENTS.md is present, which is the format the most tools read.
✗Instruction quality 8/12
Real instructions, with gaps.
Worth fixing: it never states a build, test, or run command.
7,907 characters, a workable length
uses headings, so an agent can skim it
includes copyable code blocks
✓README as an entry point 3/3
README has a clear getting-started section.
Setup 18/18 A+

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

✓Deterministic install 6/6
pnpm-lock.yaml pins the dependency tree.
Found pnpm-lock.yaml
✓Discoverable commands 6/6
Commands are declared where an agent will look for them.
scripts/ directory
✓Environment config 4/4
.env.example documents what the app needs to run.
✓Pinned runtime version 2/2
The language runtime version is pinned.
Found .nvmrc
–Reproducible environment n/a
Not applicable — a library doesn't need a container to be worked on.
Verification loop 12/25 C+

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

✓Tests exist 8/8
583 test files against 1933 source files.
e.g. .opencode/test/penpot.test.js, backend/test/backend_tests/auth_ldap_test.clj, backend/test/backend_tests/auth_login_lockout_test.clj
✗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
27 GitHub Actions workflows define 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 0/3
No static type checking.
A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.
Context economy 11/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 118 patterns.
✗File sizes fit in context 0/6
11 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.
backend/resources/app/assets/swagger-ui-4.18.3.js — 1021KB
render-wasm/src/render.rs — 207KB
frontend/packages/tokenscript/schemas.js — 165KB
✗Repository weight 2/5
About 418MB checked out. Large enough that cloning and searching are both slow.
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

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

Penpot: The open-source design platform for Product teams that need scalable collaboration.

## Setup

```
pnpm install
```

## 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

- `frontend/`    1085 source files
- `backend/`     294 source files
- `plugins/`     232 source files
- `render-wasm/` 106 source files
- `mcp/`         66 source files
- `exporter/`    43 source files

## Conventions

- Tests live alongside the code they cover, following `.opencode/test/penpot.test.js`.
- CI defines what passing means. See `.github/workflows/auto-label.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `backend/resources/app/assets/swagger-ui-4.18.3.js` is 1021KB. It will not fit comfortably in context, so read it in parts.
- Copy `.env.example` before running anything that needs configuration.

---

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/penpot/penpot.md

A draft gets the commands right and stops at the things only a maintainer knows. what AGENTS.md is explains the format itself.

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 74 out of 100

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

Other Clojure repositories, marked

tonsky/FiraCode 46 C metabase/metabase 79 A- logseq/logseq 75 B+

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