agentreadme

Report ยท marked 27 Aug 2026

nektos/act

Solid foundations, held back in a few specific places.

Go ยท 71,651 stars ยท 2,466 files ยท branch master

Fix these first

01
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.
02
Tests exist
Coverage is thin enough that an agent can break real behavior and still see green.
03
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.

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: has no code blocks.
2,935 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
โœ—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/18 A

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

โœ“Deterministic install 6/6
go.sum pins the dependency tree.
Found go.sum
โœ“Discoverable commands 6/6
Commands are declared where an agent will look for them.
Makefile
โœ—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.
go.mod declares a Go version
โ€“Reproducible environment n/a
Not applicable โ€” a library doesn't need a container to be worked on.
Verification loop 18/22 A-

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

โœ—Tests exist 4/8
49 test files against 1235 source files.
Coverage is thin enough that an agent can break real behavior and still see green.
e.g. cmd/execute_test.go, cmd/root_test.go, main_test.go
โœ“Test command is discoverable 7/7
An agent can find and run `make test`.
โœ“Continuous integration 4/4
5 GitHub Actions workflows define what "passing" means.
โœ“Lint and format rules 3/3
.golangci.yml encodes the house style.
โ€“Static type checking n/a
Not applicable โ€” the Go compiler type checks every build.
Context economy 11/20 B-

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

โœ—No committed build output 3/6
Generated output is committed: node_modules/.
Add these to .gitignore and `git rm -r --cached` them. Generated files pollute search results, so an agent grepping for a function finds the compiled copy and edits the wrong file.
โœ“.gitignore hygiene 3/3
.gitignore covers 19 patterns.
โœ—File sizes fit in context 0/6
21 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.
pkg/runner/testdata/actions/node20/node_modules/@octokit/openapi-types/types.d.ts โ€” 4642KB
pkg/runner/testdata/actions/node12/node_modules/@octokit/openapi-types/types.d.ts โ€” 4443KB
pkg/runner/testdata/actions/node16/node_modules/@octokit/openapi-types/types.d.ts โ€” 4443KB
โœ“Repository weight 5/5
About 17.7MB 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 nektos/act
# AGENTS.md

Run your GitHub Actions locally ๐Ÿš€

## Setup

```
go mod download
```

## Commands

```
make pr
make build        # produce a build
make format       # format
make format-all
make test         # run the test suite, must pass before any commit
make lint-go
```

## Layout

- `pkg/` 1221 source files
- `cmd/` 10 source files

## Conventions

- Tests live alongside the code they cover, following `cmd/execute_test.go`.
- CI defines what passing means. See `.github/workflows/checks.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `pkg/runner/testdata/actions/node20/node_modules/@octokit/openapi-types/types.d.ts` is 4642KB. 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/nektos/act.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 76 out of 100

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

Other Go repositories, marked

avelino/awesome-go 78 A- ollama/ollama 88 A golang/go 31 D kubernetes/kubernetes 74 B+ microsoft/TypeScript 82 A- fatedier/frp 96 A+

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