Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (31 loc) · 1016 Bytes

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 1016 Bytes

Contributing

Getting started

To get the repository up and running, install the dependencies from the root directory:

npm i

Then build all the packages:

npm run build

You can start the examples by running:

npm run dev
# or
npm run dev-vue

If you want to work on a specific package, open a new terminal, go to the package directory and run this command to watch for file changes:

npm run dev

Commit messages

Use Conventional Commits to format your commit messages. The available scopes are listed in commitlint.config.js.

Formatting

This project uses Prettier to format the code. It is recommended to install the Prettier extension in your code editor. You can also run the formatter manually with:

npm run format

And check for formatting issues with:

npm run format:check