Skip to content

DEV-040.md

Latest commit

 

History

History
38 lines (29 loc) · 1.1 KB

DEV-040.md

File metadata and controls

38 lines (29 loc) · 1.1 KB
Raw
id DEV-040
title Reference a Rule by ID as a Followable Link
status active
enforcement manual
severity warning
depends_on
DEV-030

Problem

When a rule points at another by loose description, the dependency is untraceable. And when the reference is plain text, or a link whose target is wrong or missing, a reader cannot click through to the rule it names.

Solution

Treat a mention of another rule as a doorway, not a name-drop: the reader should reach it by clicking, never by searching.

  1. Write the other rule's ID and make it a link to that rule's file.
  2. Mirror any hard dependency in depends_on, so prose and metadata never drift.

Which link style carries it, inline or reference, is the repo linter's business, not this rule's.

Good:  see [DEV-030](./DEV-030.md)
Bad:   see the frontmatter rule   (no ID)
Bad:   see DEV-030                (ID, but not a link)

Acceptance Criteria

  • Every rule-to-rule reference names the other rule by its ID
  • The ID is a link that resolves to that rule's file
  • A referenced dependency also appears in depends_on