IEFS006: readme

README.md exists and has no TODO markers.

Category: file_structure · Applies to: eval

What it does

Checks the package has a README.md; with readme-location = "repo-root" the repository's top-level README is accepted when the package has none. Warns once per line that still contains TODO:.

Why is this bad?

The README is the evaluation's front door. A missing one leaves users guessing at what the evaluation measures; a leftover TODO: is a section the author meant to write.

Options

• readme-location

Suppress on a line with # inspect-evals-lint: ignore[IEFS006] or ignore[readme]; select or ignore it in configuration by either, or by the prefix IEFS.