Skip to content
markdown-contract

This repo validates its own planning docs

automate-04 · Mixed

The dogfood proof: this repository’s config maps its planning corpus to six contracts, and CI validates the corpus on every push.

Builds on: A CI gate in GitHub Actions

The artifact

Section titled “The artifact”

Commands, code, and output together; comments mark which is which.

# markdown-contract.yaml (excerpt) — the config at this repository's root
mcVersion: 2
kind: config
contracts:
  decision:  ./contracts/decision.contract.yaml
  task:      ./contracts/task.contract.yaml
  milestone: ./contracts/milestone.contract.yaml
rules:
  - include: ['**/D-*.md']
    contract: decision
  - include: ['**/T-*.md']
    contract: task
  - include: ['**/M-*.md']
    contract: milestone


# the gate, run from the repo root:
$ markdown-contract validate docs/planning
Scanned 189 files; 165 matched across 6 contracts, 24 unmatched
  capability: 10
  driver: 5
  decision: 15
  milestone: 11
  product: 2
  task: 122


No findings.
# exit status: 0 — the planning corpus conforms to its contracts

What it exercises

Section titled “What it exercises”
  • real-world corpus config
  • filename-prefix glob routing
  • self-hosted dogfooding

Continue

Section titled “Continue”