Support and contributing
| I want to… | Where |
|---|---|
| Ask a question or get help | #design-system on Slack |
| Discuss about technical issue | #ds-kehitys on Slack |
| Report a bug | New issue → Bug report |
| Suggest a change to an existing component, token or icon | New issue → Change request |
| Propose a new component or feature | New issue → New feature |
| Explore an early design idea | New issue → Concept design |
| See what is being worked on | Project board |
| See what has changed | GitHub releases |
| Fix or improve a docs page | Edit this page link at the top of the page |
Release announcements are also posted on #design-system.
Before you ask
Search these docs, Storybook and existing issues, open and closed. Someone may have asked already.
Reporting a bug
A good bug report includes:
- the package and its version
- where it happens: browser, device, React or React Native version
- steps to reproduce, with a code sample or a link if possible
- what you expected and what happened instead.
Don't put security-sensitive details in an issue. Contact the team on Slack and they'll point you to a private channel.
Proposing a change or a new component
Open an issue before you start designing or building. The team checks that the proposal fits the system:
- Does more than one service need it, or could it be generalised so that they would?
- Could an existing component be extended instead?
- Is it accessible and built on existing design tokens?
- Does it work in both light and dark themes?
Once the proposal is agreed, the design is done in the YDS Figma libraries and the implementation as a pull request.
Contributing code
Pull requests are welcome. Before opening one:
- Set up the repository with the README instructions.
- Write commit messages as conventional commits.
- Add a changeset for every change that should release a new package version.
- Document new components with the docs page template.
More detail: CONTRIBUTING.md.