Report · marked 25 Aug 2026
Wei-Shaw/sub2api
An agent can work here, but it will waste turns finding its footing.
Go · 39,360 stars · 3,697 files · branch main
56
/100
B-
Instructions
3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup
10/20Whether an agent can install the project and get it running without a human. Losing marks on deterministic install and environment config.Verification loop
19/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on lint and format rules.Context economy
13/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability
10/10How quickly anything new can orient itself. Full marks.
Higher is better. Accent marks what is costing you most.
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
Deterministic install
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
The full marking
Every deduction below names the file or setting it came from.
Instructions 3/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
3/3
README has a clear getting-started section.
Setup 10/20 C+
Whether an agent can install the project and get it running without a human.
✗Deterministic install
0/6
No lockfile. An agent installing dependencies may not get what CI got.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
✓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
0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
✓Reproducible environment
2/2
dockerfile gives a known-good environment.
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
1459 test files against 3257 source files.
e.g. backend/cmd/cleanup-ingress-reject-logs/main_test.go, backend/cmd/profit-preview/main_test.go, backend/cmd/server/wire_gen_test.go
✓Test command is discoverable
7/7
An agent can find and run `make test`.
✓Continuous integration
4/4
4 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 13/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 101 patterns.
✗File sizes fit in context
0/6
38 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/ent/mutation.go — 1802KB
frontend/src/views/admin/SettingsView.vue — 525KB
backend/ent/client.go — 276KB
✗Repository weight
4/5
About 102.6MB 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 Sub2API 一站式开源中转服务，让 Claude、Openai 、Gemini、Grok订阅统一接入，支持拼车共享，更高效分摊成本，原生工具无缝使用。 ## Setup ``` # TODO: the install command. No lockfile was found, so this could not be inferred. ``` ## Commands ``` make build # produce a build make build-backend make build-frontend make test # run the test suite, must pass before any commit make test-backend make test-frontend ``` ## Layout - `backend/` 2483 source files - `frontend/` 760 source files - `deploy/` 12 source files - `skills/` 1 source file - `tools/` 1 source file ## Conventions - Tests live alongside the code they cover, following `backend/cmd/cleanup-ingress-reject-logs/main_test.go`. - CI defines what passing means. See `.github/workflows/backend-ci.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `backend/ent/mutation.go` is 1802KB. It will not fit comfortably in context, so read it in parts. - No lockfile is committed, so an install here may not match what CI produced. --- 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/Wei-Shaw/sub2api.md
Show the mark
The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.
[](https://agentreadme.com/Wei-Shaw/sub2api)Other Go repositories, marked
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.