Honk React

Reacts components exported under @honk-ds/react.

Development

The project uses Storybook for component development. Start the storybook instance by running the following command:

yarn dev

Documentation

To start a local dev server for the documentation site, run the following command:

yarn docs:dev

Releases

This project uses Semantic Release to automate package publishing when making changes to the main or next branch.

It is recommended to branch off the next branch and follow conventional commits when making changes. When your changes are ready for pull request, this should be opened against the next branch.

Read more in-depth about Fabric Releases here.

Please note that the version published will depend on your commit message structure. We use commitizen to help follow this structure:

npm install -g commitizen

When installed, you should be able to type cz or git cz in your terminal to commit your changes (replacing git commit).