Contributing

The Setup

• React v18
• TypeScript
• UI development with Storybook
• Unit test with Testing-library
• Linting with Eslint and code formatting with Prettier
• Conventional commit messages with Commitlint
• Build the library with Rollup
• Automated release with changesets

Development

• Install correct version of npm (from .nvmrc) and pnpm:

  nvm use
  npm install -g [email protected]

• Install dependencies:

  pnpm install

• Build the library:

  pnpm build

• Run storybook:

  pnpm storybook

• Unit test component with:

  pnpm test

• Creating commit messages

• Create changeset:

  pnpm changeset

Release & Publish package

This repo uses changesets to automatically generate CHANGELOG, create releases and publish to NPM registry via GitHub Actions. You can see action details at release.yml.

To automating publish this library, follow these steps:

• Create a NPM_PUBLISH_TOKEN. See this article for more details. Make sure the type of access token is Automation.

• Follow this instruction to add the created token to your GitHub Actions secrets. Name of the secret is NPM_PUBLISH_TOKEN.

• Install changeset bot.

• Adding changeset and commit.

P/S: Remember to check the Allow GitHub Actions to create and approve pull requests in your repo Settings > Actions > General & scroll to Workflow permissions.