Skip to content
markdown-contract

Frontmatter and required sections

author-01 · YAML

A complete contract, no code: typed frontmatter fields plus the sections every decision record must carry.

Builds on: nothing — start here in Author contracts in YAML.

The artifact

Section titled “The artifact”

The declarative YAML artifact, verbatim — no code required.

decision.contract.yaml
mcVersion: 2
kind: contract
frontmatter:
  type: object
  required: [id, status, created]
  properties:
    id:      { type: string, pattern: '^D-\d{4}$' }
    status:  { enum: [proposed, accepted, superseded] }
    created: { type: string, format: date }
    owner:   { type: string, format: email }
body:
  order: recognized-relative
  additionalSections: true
  sections:
    - section: Summary
    - section: Decision
    - section: Consequences
      minContains: 0
      maxContains: 1

What it exercises

Section titled “What it exercises”
  • kind: contract envelope
  • field vocabulary (type / enum / pattern / format / required)
  • section grammar (order, additionalSections, minContains)

Continue

Section titled “Continue”