changelog-entry

An advisory by default: it explains, and blocks nothing, on a changelog entry that names a Go identifier and says little else.

What it catches

A changelog entry that names a Go identifier and says little else.

Dimension

stance: the text reads as a verdict on a person, or as addressed to someone else. A finding is counted on the dimension of its rule, the cost it names to the reader.

Why

An entry says what changed for the person using the software, not the mechanism that changed. An entry of fewer than three words around an exported or qualified Go identifier names the mechanism and leaves the effect out. A lowercase name in backticks is a flag, a key or a command, which a user can act on, so it is left alone. It advises: it found nothing in the 682 fragments in changes/unreleased/.

Default decision

The code is PRF1032. The decision depends on the kind of text judged:

Changing it

A decisions table sets this rule to deny, advise or off, for everything judged or for the files a glob matches. Proofread reads the table from the file its -decisions flag names:

{
  "rules": {"changelog-entry": "deny"},
  "paths": {"blog/**": {"changelog-entry": "off"}}
}

rules applies to every file. A glob in paths applies to the files it matches, and the last match wins. A rule set to off never reports.

Seeing it

A finding names the rule, its code and the decision that applies, and links here:

{"rule": "changelog-entry", "code": "PRF1032", "decision": "advise", "url": "https://eli.gladman.cc/magus/reference/proofread/changelog-entry/"}

proofread rules prints this entry with every other rule's.

See also

• All proofread rules - every rule, grouped by what it checks
• Writing rules - how the rules apply to this repository's pages and pull requests
• The findings contract - the fields every finding carries