Design System Components

A set of living components that align with designs to form a Design System

Getting started

Install packages:

$ npm install

View components in local storybook:

$ npm start

Install husky and prepare git hook for linting

npm run husky-prepare

Build a production bundle:

$ npm run build

Contributing

Please familiarise yourself with the code style of this project when contributing. To make this process a bit easier, we suggest that you use VSCode and open the project from the workspace file.

Branching and pull requests

The master branch is the default branch for the project. That means that all pull requests should be sent here using the squash and merge option. Whenever a release is triggered, an automated action will merge the latest master into production. This is to have a place to find the source code of the published design system, and it will also deploy a new version of the Storybook.

Pull requests are set up with certain requirements.

• 1 approval from a developer
• Build needs to completed successfully
• 1 approval from designer through Chromatic

We ask that you please name your pull request in the following format:

${release_type}: ${precise short description of work}.

An example can be PATCH: fixed button hover transition time or MAJOR: renamed property link to href in <Button />.

This will help us when we want to do a release and we need to know what version we should bump to.

Please use squash and merge when you are ready to merge your pull request. This will help keep the generated changelog clean.

Release to NPM:

To publish to NPM, you need to trigger a github workflow called release package. Run it on the master branch with the correct version upgrade, and it will be released to our NPMJS registry. We ask that you follow the principle of semantic version when deciding what version you are upgrading to. If you look at the merged commits since the last release, you should be able to spot what type of release you need to do.

Example of version number changes based on release keyword:

• Patch: 0.0.1
• Minor: 0.1.0
• Major: 1.0.0