Skip to content
GitHub
Sections

Reference · Things to avoid

An error that describes the system

Forbidden
A stack trace, a database error, a file path or a framework name shown to whoever hit the page
Instead
Say what happened in the reader's terms and what to do next (05-copy.md). Keep the detail in the log, where it is useful and not public.

What this rule looks like

Forbidden
Instead

Why this rule

An error is copy, and the audience is the person reading it. Naming the stack tells a stranger which list of known problems to work through.

Kind
Rule
Section
Things to avoid
Group
Safety at the interface
Bucket
judgment
Severity
warning
Since
v0.14.0

Read as plain text