Rule 13.8
On this page

Rule 13.8

Chapter 13, Change control Test

Every change to the surface must carry a CHANGELOG entry under [Unreleased] in the house style (a bold lead naming the feature and the § or roadmap item, then what an author can now write, what each target emits, what is refused and how, and what was measured) and a surface § whose snippets compile.

The rule text and the parts under it are the compiler's own English, as the design document writes them.

Rationale

the CHANGELOG is where the reasons live between releases, and the snippet test is what keeps the surface document true.

Derives from

the [Unreleased] entries of CHANGELOG.md, whose shape the rule describes; docs/use-typeshade-surface.md §8 (“a target example stays labelled (target)”).

How it is verified

Checked by a test. A test, a gate script or a CI workflow names this rule, and the traceability check fails when a file listed below stops naming it.

Where the rule says the compiler enforces it:

doc-snippets.test.ts; review for the CHANGELOG.

The files that verify it at commit 26de7be8, each at the first line that names the rule:

See also

Source

The rule at commit 26de7be8:

Edit this page Report a problem