DOC001: README missing or nearly empty

Severity: medium · Category: documentation · Applies to: all projects

Why it matters

The README is the first thing contributors and users read. Without it, nobody knows how to run or use the project.

How to fix

Describe what the project does, how to install, run and test it.

Ignoring this rule

Skip it everywhere in devshield.yml:

ignore:
  - DOC001

Or skip one line with a comment on that line or the line above:

devshield-ignore: DOC001