agentreadme

Report Β· marked 25 Aug 2026

jaredpalmer/formik

Solid foundations, held back in a few specific places.

TypeScript Β· 34,331 stars Β· 313 files Β· branch main

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
README as an entry point
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.

The full marking

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

Instructions 1/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 1/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 14/14 A+

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

βœ“Deterministic install 6/6
yarn.lock pins the dependency tree.
Found yarn.lock
βœ“Discoverable commands 6/6
Commands are declared where an agent will look for them.
package.json scripts (dev, test, build, build:benchmark, build:codesandbox, prepublish…)
scripts/ directory
–Environment config n/a
Not applicable β€” this reads as a library, with no environment to configure.
βœ“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 22/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
13 test files against 128 source files.
e.g. e2e/basic.test.ts, packages/formik-native/test/blah.test.ts, packages/formik/test/ErrorMessage.test.tsx
βœ“Test command is discoverable 7/7
An agent can find and run `npm run test`.
βœ“Continuous integration 4/4
3 GitHub Actions workflows define what "passing" means.
βœ“Lint and format rules 3/3
.eslintrc.js encodes the house style.
βœ—Static type checking 2/3
Type checking is configured, but not in strict mode.
Turn on `"strict": true`. Type errors are the fastest feedback an agent gets, and non-strict mode silently discards most of them.
Context economy 20/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 27 patterns.
βœ“File sizes fit in context 6/6
No source file is large enough to crowd out a context window.
βœ“Repository weight 5/5
About 17.2MB 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 jaredpalmer/formik
# AGENTS.md

Build forms in React, without the tears 😭 

## Setup

```
yarn install
```

## Commands

```
yarn dev                 # run locally
yarn build               # produce a build
yarn test                # run the test suite, must pass before any commit
yarn format              # format
yarn build:benchmark
yarn build:codesandbox
yarn prepublish
yarn changeset
```

## Layout

- `website/`  66 source files
- `packages/` 26 source files
- `examples/` 25 source files
- `app/`      5 source files
- `scripts/`  3 source files
- `e2e/`      1 source file

## Conventions

- Tests live alongside the code they cover, following `e2e/basic.test.ts`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/ci.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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/jaredpalmer/formik.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 70 out of 100

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

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 68 B nilbuild/developer-roadmap 45 C vuejs/vue 67 B n8n-io/n8n 87 A anomalyco/opencode 80 A-

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