Skip to content

Commit

Permalink
Update component contribution guidelines (#130)
Browse files Browse the repository at this point in the history
  • Loading branch information
nadonomy authored Jul 10, 2023
1 parent 295edd5 commit ccae826
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions stories/design/contributing.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ While the steps in this page will produce some short term overheads, they'll pay

To try to minimise disruption in delivery - we're striving to align our roadmap with known epics where possible. If you have new or emerging needs - please let us know as early as you can in our weekly team rituals and by following these guidelines.

### Contributing a component

Components are systematised in Compound when they’re used in the Element user interface, and cross-platform. To contribute a component:

- Create a 'Components' page in the your working Figma document, isolating your draft component from your artboards & journeys
- Link to the page in ['Compound | Lobby'](https://matrix.to/#/#compound:matrix.org), to validate the need to systematise the component and agree on cross-platform naming
- Create [an issue](https://github.com/vector-im/compound/issues/new/choose) using the _New component_ issue template, filling out the component name and Figma linking
- The newly created issue is then automatically added to the [Components board](https://github.com/orgs/vector-im/projects/52/views/18) where progress is tracked

### Contributing a colour style

- Optimise for personal velocity in your designs by using semantic tokens where they exist, and base tokens where they don't
Expand All @@ -30,14 +39,6 @@ The eventual goal is for designers is for all colour decisions to be formalised
- The cross-platform typography styles are quite mature and thoroughly considered, so we don't anticipate needing more in the coming months
- If you find a need for a new typography style, or want to suggest tweaking an existing one, please let us know by discussing in [Compound | Lobby](https://matrix.to/#/#compound:matrix.org)

### Contributing a component

- Optimise for personal velocity in your designs, drafting local components in your Figma document
- Once you're confident in your user journeys:
- Create a GitHub component issue, following the guidelines and linking to your Figma document(s) leaving your draft designs and components in place.
- We'll then triage, review and if needed reach out for more discussion.
- When new components are added to the shared Figma team library, we'll let you know so you can adopt them in your designs and collaborate with engineering to build for production.

If we don't think components can be added ahead of the indicated timeline (competing priorities, bandwidth) at the least we'll advise on the most relevant known practises to minimise effort to re-componentise properly later.

Counter-intuitively, native mobile components take the longest to add to Compound, as we need to carefully consider how to override them balancing effort, scalability (e.g. over multiple operating system versions) and accessibility.
Expand Down

0 comments on commit ccae826

Please sign in to comment.