agentreadme

Report · marked 25 Aug 2026

avelino/awesome-go

Solid foundations, held back in a few specific places.

Go · 182,246 stars · 94 files · branch main

Fix these first

01
Discoverable commands
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
02
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.
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 22/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.
Also found: Copilot instructions, .cursorrules
Instruction quality 10/12
Specific enough that an agent can act on it.
Worth fixing: has no code blocks.
2,828 characters, a workable length
names the actual commands to run
uses headings, so an agent can skim it
README as an entry point 0/3
No README. This is the first file anything reads, human or machine.
Give the README an Install and a Usage heading with real commands under each. Agents pattern-match on those headings.
Setup 8/20 C

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 0/6
No declared commands. An agent has to infer how to build and run this from the file tree.
Declare the handful of commands that matter in package.json scripts, a Makefile, or a justfile. Naming them turns guesswork into a lookup.
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.
go.mod declares a Go version
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/22 A

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

Tests exist 8/8
5 test files against 10 source files.
e.g. main_test.go, maturity_test.go, pkg/markdown/convert_test.go
Test command is discoverable 7/7
An agent can find and run `go test ./...`.
Continuous integration 4/4
6 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 n/a
Not applicable — the Go compiler type checks every build.
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 9 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 12.1MB 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 avelino/awesome-go
# AGENTS.md

A curated list of awesome Go frameworks, libraries and software

## Setup

```
go mod download
```

## Commands

```
go test ./...   # run the test suite
```

## Layout

- `pkg/` 4 source files

## Conventions

- Tests live alongside the code they cover, following `main_test.go`.
- CI defines what passing means. See `.github/workflows/check-for-spammy-issues.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/avelino/awesome-go.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 78 out of 100

[![agent ready](https://agentreadme.com/badge/avelino/awesome-go.svg)](https://agentreadme.com/avelino/awesome-go)

Other Go repositories, marked

ollama/ollama 85 A golang/go 30 D kubernetes/kubernetes 72 B+ microsoft/TypeScript 80 A- fatedier/frp 96 A+ JuliusBrussee/caveman 78 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