Skip to content

DEV-120.md

Latest commit

 

History

History
36 lines (28 loc) · 1.29 KB

DEV-120.md

File metadata and controls

36 lines (28 loc) · 1.29 KB
Raw
id DEV-120
title Keep the Goal Description to the Allowed Sections
status active
enforcement manual
severity error
depends_on
DEV-110

Problem

When a Goal description carries free-form scope notes, design decisions, or instructions, those details drift out of sync with the Spec, which is the real source of truth. Readers no longer know where the authoritative scope lives.

Solution

The Goal issue description uses only these sections, plus any app-managed warning blocks:

  • # Spec (required): exactly one URL to docs/specs/<name>.md on the main branch, and nothing else.
  • # Deadline (required when assignees are present): a line ETA: <date>. Use ETA: undefined when no date is known; prefer ETA: DD-MMM-YYYY.
  • # Stakeholders Interview (optional): Google Document URLs as a bullet list.
  • Custom H1 sections (optional): additional headings for grouping issue or PR references only, with no free-form text.

Scope notes, design decisions, and instructions belong in the Spec, not here.

Acceptance Criteria

  • The description uses only the allowed sections
  • # Spec is exactly one main-branch spec URL
  • # Deadline includes an ETA: line when assignees are present
  • No scope notes, design decisions, or free-form text in the description