Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (35 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 1.49 KB

Contributing

Hi there! We're excited about your interest in contributing to Koobiq React. Before submitting your contribution, please take a moment to read the following guide:

Quick start

Follow these steps to start the development mode:

  • Clone the repository and navigate to the created directory.
  • Run the command pnpm dev in the terminal.

Documentation will be available at http://localhost:6006. All development is conducted there. For convenience, you can go directly to the page of the component you are working on.

Prerequisites

  • Node.js v20
  • pnpm v9

Tech stack

Our technology stack:

Available Scripts

  • pnpm run dev — will run the Storybook in development mode
  • pnpm run test — will run unit tests on every change
  • pnpm run lint — will lint the code once
  • pnpm run type-check — will check the typing of the code once

🛡 Public API guard

The public API of each component and package is pinned in tools/public_api_guard/. Before opening a PR:

pnpm build
pnpm check-api

If the API change is intentional, refresh the snapshots and commit them:

pnpm approve-api                # refresh all
pnpm approve-api Button         # refresh a single component
pnpm approve-api react-icons    # refresh a single package