Skip to content

DOC003: CONTRIBUTING or CHANGELOG missing

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

Why it matters

Contribution guidelines and a changelog help others adopt and upgrade the project.

How to fix

Add CONTRIBUTING.md and CHANGELOG.md.

Ignoring this rule

Skip it everywhere in devshield.yml:

ignore:
  - DOC003

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

devshield-ignore: DOC003