agentreadme

Report · marked 26 Aug 2026

Imbad0202/academic-research-skills

An agent can work here, but it will waste turns finding its footing.

Python · 43,683 stars · 2,583 files · branch main

Fix these first

01
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.
02
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.
03
Instruction quality
Worth fixing: it never states a build, test, or run command; has no code blocks.

The full marking

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

Instructions 14/27 C+

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

Agent instruction file 8/12
Copilot instructions 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 Copilot instructions alongside it costs nothing.
Instruction quality 6/12
Real instructions, with gaps.
Worth fixing: it never states a build, test, or run command; has no code blocks.
2,630 characters, a workable length
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 6/14 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.
scripts/ directory
Environment config n/a
Not applicable — this reads as a library, with no environment to configure.
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 n/a
Not applicable — a library doesn't need a container to be worked on.
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
579 test files against 438 source files.
e.g. docs/design/2026-04-29-ars-v3.6.7-downstream-agent-pattern-protection-spec.md, docs/design/2026-04-30-ars-v3.6.7-step-6-orchestrator-hooks-spec.md, docs/design/2026-04-30-ars-v3.6.8-trust-provenance-and-drift-transparency-spec.md
Test command is discoverable 7/7
An agent can find and run `pytest`.
Continuous integration 4/4
14 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 16/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 14 patterns.
File sizes fit in context 2/6
12 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.
scripts/test_dispatch_e4_panel.py — 172KB
scripts/test_check_phase_conformance.py — 155KB
scripts/check_re_review_synthesis.py — 143KB
Repository weight 5/5
About 21.4MB 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 Imbad0202/academic-research-skills
# AGENTS.md

Academic Research Skills for Claude Code: research → write → review → revise → finalize

## Setup

```
npm install
```

## Commands

```
pytest   # run the test suite
```

## Layout

- `scripts/` 425 source files
- `tools/`   4 source files
- `evals/`   3 source files
- `tests/`   3 source files
- `pi/`      2 source files
- `hooks/`   1 source file

## Conventions

- Tests live alongside the code they cover, following `docs/design/2026-04-29-ars-v3.6.7-downstream-agent-pattern-protection-spec.md`.
- CI defines what passing means. See `.github/workflows/changelog-covers-merges.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `scripts/test_dispatch_e4_panel.py` is 172KB. 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/Imbad0202/academic-research-skills.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 65 out of 100

[![agent ready](https://agentreadme.com/badge/Imbad0202/academic-research-skills.svg)](https://agentreadme.com/Imbad0202/academic-research-skills)

Other Python repositories, marked

vinta/awesome-python 81 A- NousResearch/hermes-agent 84 A- TheAlgorithms/Python 66 B yt-dlp/yt-dlp 54 C+ Significant-Gravitas/AutoGPT 63 B microsoft/markitdown 46 C

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