# cleanlab-design-system

## Installing this package in your project

| Package Manager | Install Command                       |
| --------------- | ------------------------------------- |
| npm             | `npm install @cleanlab/design-system` |
| pnpm            | `pnpm add @cleanlab/design-system`    |
| yarn            | `yarn add @cleanlab/design-system`    |

## Local development

1. Install with `pnpm i` ([How to install pnpm](https://pnpm.io/installation#using-corepack). We recommend using the Corepack method)
2. Start a Storybook dev server with `pnpm dev`
3. Open Storybook at `http://localhost:6006/`

## Creating a new release

- Create a new PR on Github
- Prefix your PR name as below name to trigger a release when the PR is merged

  | PR name                                | Release type                                                             |
  | -------------------------------------- | ------------------------------------------------------------------------ |
  | `chore: Update stories`                | \~**Patch**\~ Update build process, documentation, etc. No code changes. |
  | `fix: Incorrect typography keys`       | \~**Patch**\~ Fix Release                                                |
  | `feat: Add Button component`           | \~**Minor**\~ Feature Release                                            |
  | `feat!: Removed List component`        | \~**Major**\~ Breaking Release                                           |
  | `fix!: Renamed "Butttton" to "Button"` | \~**Major**\~ Breaking Release                                           |