Skip to content
Esc
navigateopen⌘Jpreview
On this page

mattpocock-adr-structure-invalid

Reports a Matt Pocock Profile Architecture Decision Record without its required title and decision paragraph.

← All Rules

What it does

Reports an Architecture Decision Record that does not contain exactly one H1 followed immediately by an authored paragraph of one to three sentences before any later heading.

Why it matters

Each record begins with a title and a concise statement of the decision before optional detail.

Examples

Non-passing

# Use Postgres

- Store durable application data in Postgres.

## Consequences

Passing

# Use Postgres

We will use Postgres for durable application data.

## Consequences

When it applies

This is a declarative requirement of the mattpocock@1 Profile. Selecting that Profile applies the requirement to candidate adr documents; it is not selected through the rules array.

References

See Presswork Configuration for the Profile contract and src/profile-requirements.ts for structural evaluation.