@avalabs/core-k2-components

K2 Component Library 🏔

Storybook:

https://k2-components.pages.dev

Figma:

https://www.figma.com/file/TV71q8pCAuhfd9ChvYUXZ6/Design-System

Getting started

To view the Storybook & Docs locally:

pnpm i # install dependencies
pnpm storybook

To install as a dependency:

pnpm add @avalabs/core-k2-components
# or
yarn add @avalabs/core-k2-components
# or
npm i @avalabs/core-k2-components

Release process

The project uses semantic versioning and an automated release process to maintain the version number. The process should be to create a feature branch off of develop. Once your feature is complete you create a PR into develop. The develop branch will run tests and upon passing it will cut an alpha release. You can install this alpha release, make sure it works and once verified develop can be merged into main. The main branch will run the same process but the end result will be an official release.

To install the latest alpha release, once the build has finished, run pnpm add @avalabs/core-k2-components@develop. To install the latest stable release simply run pnpm add @avalabs/core-k2-components.

The releases and their versions are based off of the commit messages. As a result it is important that you create commitizen friendly commit messages. The format for these commit messages is as so type(scope): your message. For help with this you can use the cli tool by running npx git-cz.

To trigger a release manually without a code change, push an empty commit with the appropriate commit message to trigger a version bump and release.