SH301: .env.example missing or incomplete¶

Severity: low · Category: configuration · Applies to: all projects

Why it matters¶

A committed .env.example documents which settings the application needs. Without it new developers and deployments have to guess.

Create .env.example with every key from .env and placeholder values.

devshield fix can resolve this rule for the cases it can change safely. Preview it with devshield fix --dry-run --only SH301.

Skip it everywhere in devshield.yml:

ignore:
  - SH301

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

devshield-ignore: SH301