Skip to content

DEV-350.md

Latest commit

 

History

History
40 lines (31 loc) · 1.16 KB

DEV-350.md

File metadata and controls

40 lines (31 loc) · 1.16 KB
Raw
id DEV-350
title Mark a Design PR docs(ui) With a Design Section
status active
enforcement manual
severity error
depends_on
DEV-340

Problem

Design work without a consistent type and scope, or without a structured design reference, is hard to find, track, and review against the intended screens.

Solution

Give design work a consistent home.

  1. Use docs(ui) as the type and scope. Name it for what users gain, per DEV-340, for example docs(ui): sort the transactions table.
  2. Add a ## Design section to the relevant Spec file, structured with this markup:
## Design
- [/page](https://figma.com/your-design-file-url)
  - ./page/{params}
    - (group)
      - [[state]](https://figma.com/your-design-file-url)

Key: /... a page, {...} a dynamic URL parameter, (...) a grouping of related features or components, [...] a specific state (for example a popup), and indentation represents nesting.

Acceptance Criteria

  • The design PR uses the docs(ui) type and scope
  • A ## Design section is added to the relevant Spec
  • The section uses the page, parameter, group, and state markup