README exists and is adequately maintained
Why it matters
A missing or boilerplate README means the first developer to clone your project — or you on a new machine six months from now — must read source code to discover how to install dependencies, configure environment variables, and start the server. ISO 25010 maintainability.analysability fails at the project entry point. An unmodified create-next-app README is indistinguishable from a project with no documentation at all: it describes Next.js, not your project. Every undocumented setup step is a blocker for every future contributor.
Severity rationale
High because a missing or boilerplate README blocks every new contributor from setting up and running the project without direct help from the original author.
Remediation
Write a minimum viable README covering what the project does, how to install it, and how to run it. Reference src/app/ for the route structure and call out non-obvious setup steps:
# Project Name
One paragraph: what this does and who it's for.
## Setup
1. `npm install`
2. Copy `.env.example` to `.env.local` and fill in the values
3. `npm run dev` — runs on http://localhost:3000
## Project Structure
- `src/app/` — routes and pages
- `src/components/` — shared UI components
- `src/lib/` — utilities and third-party wrappers
Fifteen minutes of writing now saves hours of onboarding friction later.
DetectionPro
The detection method for this pattern is part of AuditBuffet Pro.
The full method (what to look for, pass and fail conditions, and how results get reported) ships inside the Code Maintainability Audit. The pattern definition, severity rationale, and remediation remain openly licensed under CC-BY-4.0.
External references
- iso-25010:2011 · maintainability.analysability — Analysability
Taxons
History
- 2026-04-18·v1.0.0·Initial import from code-maintainability·automated