docs: add modular design system adr#8012
Conversation
|
joshblack
added
skip changeset
|
🤖 Lint issues have been automatically fixed and committed to this PR. |
|
🤖 Lint issues have been automatically fixed and committed to this PR. |
Added components to the list of breaking components.
|
🤖 Lint issues have been automatically fixed and committed to this PR. |
|
🤖 Lint issues have been automatically fixed and committed to this PR. |
Co-authored-by: Leslie Cohn-Wein <lesliecdubs@github.com>
|
🤖 Formatting issues have been automatically fixed and committed to this PR. |
joshblack
requested review from
francinelucca,
jonrohan,
lesliecdubs and
siddharthkp
There was a problem hiding this comment.
Pull request overview
Adds documentation and contributor tooling to formalize the “Modular Design System” approach for Primer React, including an ADR and updated style guide guidance that defines a spectrum-of-abstraction model for component APIs.
Changes:
- Document the spectrum-of-abstraction API model (config, presentational, base, utilities) in
contributor-docs/style.md. - Add a new ADR (
adr-024-modular-ds.md) capturing context, decision, examples, and consequences from the Modular DS workshop. - Introduce a
style-guideskill and modular DS-focused agent definitions to help guide implementation/review work.
Show a summary per file
| File | Description |
|---|---|
| contributor-docs/style.md | Adds a new style-guide section defining the spectrum-of-abstraction model and when to use each API type. |
| contributor-docs/adrs/adr-024-modular-ds.md | New ADR documenting the Modular DS decision, with layered examples and consequences. |
| .github/skills/style-guide/SKILL.md | New skill that points contributors/reviewers to contributor-docs/style.md as the API/source-of-truth. |
| .github/agents/modular-ds-reviewer.agent.md | Adds a read-only reviewer agent spec focused on checking alignment with the modular DS style-guide principles. |
| .github/agents/modular-ds-implementer.agent.md | Adds an implementer agent spec focused on building components following the modular DS model. |
Review details
- Files reviewed: 5/5 changed files
- Comments generated: 1
- Review effort level: Low
…o docs/add-modular-ds-adr
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…r, port prop-getter shape, note RSC export convention - Entry-points table in the implementer agent now reads as target-state rather than shipped fact (foundations/hooks subpaths don't exist in packages/react/package.json yet). - modular-ds-spectrum-model links to ADR-024, hedged since #8012 (which adds the ADR file) hasn't merged yet. - modular-ds-utilities now shows the prop-getter hook shape in code, not just prose, per the pr-7778 reviewer's ask for concrete patterns. - modular-ds-base-components and modular-ds-presentational-components note that their dot-notation examples are illustrative only; the RSC-safe flat-export convention is what ships. - Implementer agent's validation section now points to modular-ds-tdd-a11y-test-backfill instead of duplicating the 5-step list. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Introduces an ADR as a follow up to our Modular Design System Workshop. This ADR defines the abstraction model we'll use for component development moving forward. Certain deliverables, like what components we are breaking up or what base components we would like to ship, have been moved to pitches over in github/primer.
This ADR also includes initial agents, skills, and additions to our style document that reflect the spectrum of abstraction being proposed.