agentreadme

Report · marked 10 Oct 2026

jgraph/drawio-desktop

Solid foundations, held back in a few specific places.

JavaScript · 63,452 stars · 95 files · branch dev

Fix these first

01
Agent instruction file
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.
02
Lint and format rules
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
03
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.

The full marking

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

Instructions 21/27 A-

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

✗Agent instruction file 9/12
CLAUDE.md is present, but not the vendor-neutral AGENTS.md.
Rename or symlink to AGENTS.md so tools other than one vendor's can read it. Keeping CLAUDE.md alongside it costs nothing.
✗Instruction quality 10/12
Specific enough that an agent can act on it.
Worth fixing: it's 23k characters, which burns context on every single turn.
names the actual commands to run
uses headings, so an agent can skim it
includes copyable code blocks
✗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 16/20 A-

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, sync, test, release-win, release-win-arm64, release-appx…)
✗Environment config 2/4
Env vars are mentioned in the README but there's no example file to copy.
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.
Found .nvmrc
✗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 19/25 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
12 test files against 35 source files.
e.g. src/test/backup-file.test.js, src/test/cli-args.test.js, src/test/config-paths.test.js
✓Test command is discoverable 7/7
An agent can find and run `npm run test`.
✓Continuous integration 4/4
8 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 18/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 8 patterns.
✗File sizes fit in context 4/6
1 source file is 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.
src/main/electron.js — 117KB
✓Repository weight 5/5
About 3.5MB 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 jgraph/drawio-desktop
# AGENTS.md

Official electron build of draw.io

## Setup

```
npm ci
```

## Commands

```
npm run start               # run the app
npm run test                # run the test suite, must pass before any commit
npm run sync
npm run release-win
npm run release-win-arm64
npm run release-appx
npm run release-linux
npm run release-snap
```

## Layout

- `src/`   27 source files
- `build/` 6 source files

## Conventions

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

## Gotchas

- Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that.
- `src/main/electron.js` is 117KB. It will not fit comfortably in context, so read it in parts.

---

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/jgraph/drawio-desktop.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good JavaScript AGENTS.md looks like covers what to add by hand, and 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 82 out of 100

[![agent ready](https://agentreadme.com/badge/jgraph/drawio-desktop.svg)](https://agentreadme.com/jgraph/drawio-desktop)

Other JavaScript repositories, marked

affaan-m/ECC 89 A react/react 71 B+ trekhleb/javascript-algorithms 69 B DietrichGebert/ponytail 74 B+ Snailclimb/JavaGuide 53 C+ airbnb/javascript 54 C+

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