Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 934 Bytes

CONTRIBUTING.md

File metadata and controls

59 lines (36 loc) · 934 Bytes

Contributing

First, thanks for being interested in contributing on this project!

Development

Pre-request

Before starting, you should ensure your mechine is having:

Node >= 16

pnpm >= 7

Setup

Fork this repo, the clone it to your local mechine and intsall the dependencies:

pnpm install # pnpm i

Then you need to build all packages under common:

pnpm run build:common

Developing for Component

We use a vite project in dev-server for development.

Using the following command you can start development server for specify component:

pnpm run serve [component]

Developing for Document

We alse use a vite project for documenting, you can start it locally:

pnpm run serve:docs

Create New Component

you can create some templete files by:

pnpm run create [component-name]

Then you need to update exports files by:

pnpm run bootstrap