Skip to content

DEV-030.md

Latest commit

 

History

History
49 lines (39 loc) · 1.3 KB

DEV-030.md

File metadata and controls

49 lines (39 loc) · 1.3 KB
Raw
id DEV-030
title Carry the Shared Rule Frontmatter
status active
enforcement manual
severity error
depends_on
DEV-020

Problem

Tooling and cross-references rely on structured metadata. A rule without consistent frontmatter cannot be indexed, linked by ID, or ordered against its dependencies.

Solution

Every rule file opens with frontmatter carrying these shared fields:

---
id: ABC-010
title: "Example behavior"
status: active
enforcement: manual
severity: warning
depends_on: ["ABC-005"]
---

depends_on is a YAML list; use [] when the rule has no dependencies.

Field Meaning
id Rule ID, matches the filename
title Short, human-readable behavior name
status Lifecycle, for example active
enforcement How the rule is enforced, for example manual
severity error or warning
depends_on Rule IDs that must hold before this one applies

A rules system may add its own fields (for example a funnel stage and ordering). Those extra fields are documented in that system's own rules index, not here.

Acceptance Criteria

  • Frontmatter carries id, title, status, enforcement, severity
  • id matches the filename
  • depends_on lists the rule IDs that must hold first, where any apply