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

No CONTRIBUTING guide

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

A licensed/open-source-looking project has no CONTRIBUTING.md to guide external contributors.

Why it matters

A LICENSE signals the project accepts outside use, but without a CONTRIBUTING guide, would-be contributors do not know how to set up a dev environment, what checks must pass, or whether PRs are even welcome. The result is either silence or PRs that miss your conventions and cost review time. A one-page guide answers this once instead of per-PR.

How to fix it

Add CONTRIBUTING.md at the repository root covering: how to set up a dev environment (clone, install, env vars), how to run tests and lint, branch and commit conventions if you have them, and where to open issues versus PRs. Keep it accurate to what the repo actually enforces; if you do not want contributions, say so explicitly, which is also a valid answer.

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