Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (33 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1.42 KB
Raw

Contributing to inovex Elements

Hello, nice to meet you 👋

Thanks for your interest in contributing to this project to make it even better. This guide will help you understand how to get started quickly and jump right into coding.

Quick Start

We use mise for managing Node.js and package manager versions.

  1. Setup Environment:

    # Make sure you have `mise` installed on your machine
mise install

  2. Install Dependencies:

    pnpm install

  3. Start Development Server:

    pnpm start:storybook

    This starts both the core components build in watch mode and the local Storybook documentation playground.

Documentation & Architecture

To understand how our repository is structured and the rules we follow when developing components, please read our local documentation files:

Submitting changes

Once your code is ready, ensure it meets our quality standards by running the quality control script:

pnpm qc

This will run linting, formatting, build, and tests. If everything passes, you're ready to open a Pull Request!