Source code Code quality

Missing README / runbook docs

Part of the Engineering practices check · fix arrives as a guide

What it is

The repository has no README covering how to run the project, or no runbook describing what to do when the production service misbehaves.

Why it matters

The cost lands on the worst day — a new engineer onboarding, or whoever is on call at 3am for a service they did not build. Undocumented knowledge is also single-person knowledge.

How to fix it

Write down how to run it locally, what environment variables it needs, and how to deploy it. For the runbook, one page per recurring alert with the first three things to check beats a comprehensive document nobody finishes.

Run them all on your app

Connect your repo and your live services with read-only scopes. The first scan is free, and nothing changes without your approval.