Skip to content

M0018 repo-files

Rule: The repo carries its rule files.

Code M0018 (stable, never reused)
Id repo-files
Category repo
Source spirit_level
Fix by hand

Level per tier

Tier Level Reason
small warn every work repo carries README, AGENTS, CLAUDE, FEATURES and CHANGELOG
small-workspace warn every work repo carries README, AGENTS, CLAUDE, FEATURES and CHANGELOG
medium warn every work repo carries README, AGENTS, CLAUDE, FEATURES and CHANGELOG
big warn every work repo carries README, AGENTS, CLAUDE, FEATURES and CHANGELOG
ai deny AGENTS.md holds the rules every agent reads; CLAUDE.md points to it
embedded off
ui off
egui off
units-strict off
units-paranoid off

Parameters

Name Type Default Meaning
files list of strings ["README.md", "AGENTS.md", "CLAUDE.md", "FEATURES.md", "CHANGELOG.md"] files that must exist at the root

Why

Every work repo carries its rules where people and agents look first: README.md (what it is), AGENTS.md (how to work in it), CLAUDE.md (pointing at AGENTS.md), FEATURES.md (status by stable id) and CHANGELOG.md (what changed).

How to fix

Add the missing file. The list is the parameter files.

Configure

[lints.repo-files]
level = "deny"
files = ["README.md", "AGENTS.md", "CLAUDE.md", "FEATURES.md", "CHANGELOG.md"]
reason = "why this project wants it at this level"

Allow one finding in the code with // spirit-level: allow(repo-files) <reason> (waivers); the code works there too, as in [lints.M0018].