Will It Vibe?
DOCS-019Info severity-2 points

No changelog

Part of Documentation, UX & Accessibility, which counts for 15% of the overall score. When this check fires it deducts 2 points from that category, once per scan, no matter how many places it turns up.

What it detects

The package version suggests multiple releases have happened, but there's no CHANGELOG.md tracking what changed.

Why it matters

A version number beyond 1.0.0 says releases have shipped, but with no changelog, users upgrading have no way to see what changed, what broke, or why their integration stopped working. You lose that history too: six months later, "what went into 1.3?" becomes a git archaeology session. A changelog is the cheapest release documentation there is.

How to fix it

Add CHANGELOG.md at the repository root in Keep a Changelog format: one section per version, newest first, with Added / Changed / Fixed subsections and dates. Backfill at least the current version from git log and tags, and mark older versions as unrecorded rather than inventing history. Going forward, either update it in each release PR or automate it with Changesets or release-please if you use conventional commits.

The paid report includes a ready-to-paste prompt for your AI coding agent for every check it finds, pointed at the exact findings from your scan. See pricing

Does your repo trip this check?

Paste a GitHub URL or drop a project folder. Scans run in your browser and take seconds.

Scan your repo

Related Documentation, UX & Accessibility checks