Skip to content

one_command_setup assessor should check CLAUDE.md/AGENTS.md, not just README #451

@jwm4

Description

@jwm4

Summary

The one_command_setup assessor (assessors/structure.py) only searches README.md for setup commands via _find_setup_command() and _is_setup_prominent(). It does not check CLAUDE.md or AGENTS.md.

For agent-readiness, CLAUDE.md is arguably the more important location. An agent reads CLAUDE.md first, so a setup command documented there is immediately actionable. A repo like mlflow/mlflow has its dev setup command (uv run bash dev/run-dev-server.sh) documented in CLAUDE.md but not prominently in their README, and scores 60/100 as a result.

Proposal

Have _find_setup_command() and _is_setup_prominent() also search CLAUDE.md and AGENTS.md. A setup command found in an agent context file should earn at least the same credit as one found in README.

Context

Discovered while assessing mlflow/mlflow (score: 60.4, Silver). This was one of the attributes where the score didn't reflect the repo's actual agent-readiness.

Posted by Bill Murdock with assistance from Claude Code.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions