We welcome contributions to the design system. Your involvement helps us build a better, more comprehensive design system.
Here are the easiest ways you can contribute to the design system:
Create bug fix requests
If you find a bug with the design system, you can flag it with the team and create a bug in Azure DevOps. The design system team have a flexible backlog and will prioritise urgent bug fixes over anything else.
Suggest an improvement
If there’s anything we can change to make using the design system easier to use, then we would like to know about it. Make suggestions for improvements to the team and we’ll consider them for development during planning.
Improve the documentation
If any of the documentation is out of date, incorrect, or could be clearer, let us know and we’ll fix it.
Feature requests
If you have an idea for a new feature that could benefit the design system, we’d love to hear it. Reach out to the team with your suggestions and we’ll add it as a new design system candidate.
Contributing code
We also welcome more direct contributions in the form of pull requests to the design system repo.
To work with the design system project, follow these steps.
- Clone the design-system repository
- Create a branch for your changes e.g. feature/12345-button-docs-improvement or bugfix/54321-error-handling
- Run npm install to install package dependencies
- Run npm run storybook to start storybook and begin developing
- If contributing new features ensure that you add Storybook stories and interaction tests
- Check the design system code definition of done
- Create a PR into a design system release
If you need any help along the way, reach out and we’ll help get you up and running.