Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 1016 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (23 loc) · 1016 Bytes

Contributing

Thanks for being interested in contributing to this project!

Development

Setup

Clone this repo to your local machine and install the dependencies.

npm i

We use VitePress for rapid development and documenting. You can start it locally by

npm run docs:dev

Contributing

Feel free to enhance the existing components and functions or add new ones. Please try not to introduce breaking changes.

Before you start working, it's better to open an issue to discuss first.

Code Style

This project uses @antfu/eslint-config to enforce consistent code style.

Enable Run eslint --fix on save in your editor to automatically fix issues.

WebStorm

Open the Settings/Preferences dialog (+,), go to Languages & Frameworks | JavaScript | Code Quality Tools | ESLint, and select the Run eslint --fix on save checkbox.

Thanks

Thank you again for being interested in this project! You are awesome!