Contribute
Contribute
The decision flow to follow before proposing a new component or variant, and the pages of the contribution process.
In this section
Section titled “In this section”| Page | Contents |
|---|---|
| Proposal process | When to write a proposal (RFC) and a decision record (ADR), how they are reviewed; both templates |
| Component checklist | Everything a component or change needs to count as done |
| Naming | Names of components, props, parts, tokens, icons, stories and pages |
| Versioning | Release types, changesets, the 0.x rule and deprecation |
Decision flow
Section titled “Decision flow”For a new need, answer these questions in order:
- Does an existing component do the job? Search the Components overview, then check “When to use” on the component’s Usage tab. If it does, use it.
- Is a prop or variant of an existing component enough? For example a new tone or size. If the difference is on an existing axis and appears on at least two screens, propose a variant (REUSE-03); the component’s contract, tests and docs are updated together.
- Is the behaviour different? Write a specialisation that imports the base component and only adds behaviour (REUSE-02).
- Does the need combine several components into a workflow? That is a pattern or a pattern’s extension slot; see Patterns.
- If none of these, start the proposal process.
A brand or look difference is a token matter; it does not need a new component (REUSE-04).