👨🏻‍💻 Installation

To install the package, run the following command:

npm i @babylonlabs-io/core-ui

📝 Commit Format & Automated Releases

This project uses Conventional Commits and semantic-release to automate versioning, changelog generation, and npm publishing.

✅ How It Works

1. All commits must follow the Conventional Commits format.
2. When changes are merged into the main branch:
   • semantic-release analyzes commit messages
   • Determines the appropriate semantic version bump (major, minor, patch)
   • Tags the release in Git with release change log
   • Publishes the new version to npm

🧱 Commit Message Examples

feat: add support for slashing script
fix: handle invalid staking tx gracefully
docs: update README with commit conventions
refactor!: remove deprecated method and cleanup types

Note: For breaking changes, add a ! after the type ( e.g. feat!: or refactor!:) and include a description of the breaking change in the commit body.

🚀 Releasing

Just commit your changes using the proper format and merge to main. The CI pipeline will handle versioning and releasing automatically — no manual tagging or version bumps needed.

📖 Storybook

To view the component library, run:

npm run storybook

💪 Usage

Provide examples of how to use the library in a project. Include code snippets and explanations.

import { ComponentName } from "@babylonlabs-io/core-ui";

function App() {
  return <ComponentName prop="value" />;
}